blob: 374c66283ac5bd8db9478c5604e4da2834d69d21 [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>
J. Bruce Fields1557aca2009-12-04 19:36:06 -050040#include "nfsfh.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070041
Linus Torvalds1da177e2005-04-16 15:20:36 -070042typedef struct {
43 u32 cl_boot;
44 u32 cl_id;
45} clientid_t;
46
47typedef struct {
J. Bruce Fieldsd3b313a2011-09-15 15:02:41 -040048 clientid_t so_clid;
49 u32 so_id;
Linus Torvalds1da177e2005-04-16 15:20:36 -070050} stateid_opaque_t;
51
52typedef struct {
53 u32 si_generation;
54 stateid_opaque_t si_opaque;
55} stateid_t;
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
Benny Halevy8c10cbd2009-10-19 12:04:53 +020057#define STATEID_FMT "(%08x/%08x/%08x/%08x)"
58#define STATEID_VAL(s) \
J. Bruce Fieldsd3b313a2011-09-15 15:02:41 -040059 (s)->si_opaque.so_clid.cl_boot, \
60 (s)->si_opaque.so_clid.cl_id, \
61 (s)->si_opaque.so_id, \
Benny Halevy8c10cbd2009-10-19 12:04:53 +020062 (s)->si_generation
63
J. Bruce Fields227f98d92010-02-18 08:27:24 -080064struct nfsd4_callback {
J. Bruce Fieldsfb003922010-05-31 18:21:37 -040065 void *cb_op;
66 struct nfs4_client *cb_clp;
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -050067 struct list_head cb_per_client;
J. Bruce Fieldsfb003922010-05-31 18:21:37 -040068 u32 cb_minorversion;
J. Bruce Fields58784532010-05-16 16:47:08 -040069 struct rpc_message cb_msg;
70 const struct rpc_call_ops *cb_ops;
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -050071 struct work_struct cb_work;
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -050072 bool cb_done;
J. Bruce Fields227f98d92010-02-18 08:27:24 -080073};
74
J. Bruce Fieldsd5477a82011-09-08 12:07:44 -040075struct nfs4_stid {
76#define NFS4_OPEN_STID 1
77#define NFS4_LOCK_STID 2
78#define NFS4_DELEG_STID 4
J. Bruce Fieldsf7a4d872011-09-16 20:12:38 -040079/* For an open stateid kept around *only* to process close replays: */
80#define NFS4_CLOSED_STID 8
J. Bruce Fields3bd64a52013-04-09 17:02:51 -040081/* For a deleg stateid kept around only to process free_stateid's: */
82#define NFS4_REVOKED_DELEG_STID 16
J. Bruce Fieldsf7a4d872011-09-16 20:12:38 -040083 unsigned char sc_type;
J. Bruce Fieldsd5477a82011-09-08 12:07:44 -040084 stateid_t sc_stateid;
J. Bruce Fields2a74aba2011-09-23 17:20:02 -040085 struct nfs4_client *sc_client;
J. Bruce Fieldsd5477a82011-09-08 12:07:44 -040086};
87
Linus Torvalds1da177e2005-04-16 15:20:36 -070088struct nfs4_delegation {
J. Bruce Fields996e0932011-10-17 11:14:48 -040089 struct nfs4_stid dl_stid; /* must be first field */
NeilBrownea1da632005-06-23 22:04:17 -070090 struct list_head dl_perfile;
91 struct list_head dl_perclnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 struct list_head dl_recall_lru; /* delegation recalled */
93 atomic_t dl_count; /* ref count */
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 struct nfs4_file *dl_file;
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 u32 dl_type;
96 time_t dl_time;
J. Bruce Fieldsb53d40c2009-05-01 19:50:00 -040097/* For recall: */
J. Bruce Fieldsb53d40c2009-05-01 19:50:00 -040098 struct knfsd_fh dl_fh;
J. Bruce Fields3aea09d2009-05-01 20:11:12 -040099 int dl_retries;
J. Bruce Fields227f98d92010-02-18 08:27:24 -0800100 struct nfsd4_callback dl_recall;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101};
102
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103/* client delegation callback info */
J. Bruce Fieldsc237dc02009-04-29 19:09:19 -0400104struct nfs4_cb_conn {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 /* SETCLIENTID info */
Jeff Laytonaa9a4ec2009-08-14 12:57:57 -0400106 struct sockaddr_storage cb_addr;
Takuma Umeya6f3d7722010-12-15 14:09:01 +0900107 struct sockaddr_storage cb_saddr;
Jeff Laytonaa9a4ec2009-08-14 12:57:57 -0400108 size_t cb_addrlen;
J. Bruce Fields8b5ce5c2010-10-19 17:31:50 -0400109 u32 cb_prog; /* used only in 4.0 case;
110 per-session otherwise */
Andy Adamsonab52ae62009-06-16 04:20:53 +0300111 u32 cb_ident; /* minorversion 0 only */
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500112 struct svc_xprt *cb_xprt; /* minorversion 1 only */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113};
114
J. Bruce Fieldsf459e452011-09-09 09:06:12 -0400115static inline struct nfs4_delegation *delegstateid(struct nfs4_stid *s)
116{
117 return container_of(s, struct nfs4_delegation, dl_stid);
118}
119
Andy Adamsona6496372009-08-28 08:45:01 -0400120/* Maximum number of slots per session. 160 is useful for long haul TCP */
121#define NFSD_MAX_SLOTS_PER_SESSION 160
Andy Adamsonec6b5d72009-04-03 08:28:28 +0300122/* Maximum number of operations per session compound */
123#define NFSD_MAX_OPS_PER_COMPOUND 16
Andy Adamson557ce262009-08-28 08:45:04 -0400124/* Maximum session per slot cache size */
J. Bruce Fields24906f32014-03-12 15:17:18 -0400125#define NFSD_SLOT_CACHE_SIZE 2048
Andy Adamsona6496372009-08-28 08:45:01 -0400126/* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
127#define NFSD_CACHE_SIZE_SLOTS_PER_SESSION 32
128#define NFSD_MAX_MEM_PER_SESSION \
129 (NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
Andy Adamson074fe892009-04-03 08:28:15 +0300130
Andy Adamson7116ed62009-04-03 08:27:43 +0300131struct nfsd4_slot {
Andy Adamson557ce262009-08-28 08:45:04 -0400132 u32 sl_seqid;
133 __be32 sl_status;
134 u32 sl_datalen;
J. Bruce Fields73e79482012-02-13 16:39:00 -0500135 u16 sl_opcnt;
136#define NFSD4_SLOT_INUSE (1 << 0)
137#define NFSD4_SLOT_CACHETHIS (1 << 1)
J. Bruce Fieldsbf5c43c2012-02-13 16:56:19 -0500138#define NFSD4_SLOT_INITIALIZED (1 << 2)
J. Bruce Fields73e79482012-02-13 16:39:00 -0500139 u8 sl_flags;
Andy Adamson557ce262009-08-28 08:45:04 -0400140 char sl_data[];
Andy Adamson7116ed62009-04-03 08:27:43 +0300141};
142
Alexandros Batsakis6c18ba92009-06-16 04:19:13 +0300143struct nfsd4_channel_attrs {
144 u32 headerpadsz;
145 u32 maxreq_sz;
146 u32 maxresp_sz;
147 u32 maxresp_cached;
148 u32 maxops;
149 u32 maxreqs;
150 u32 nr_rdma_attrs;
151 u32 rdma_attrs;
152};
153
J. Bruce Fieldsacb28872012-03-27 14:50:26 -0400154struct nfsd4_cb_sec {
J. Bruce Fields12fc3e92012-11-05 16:01:48 -0500155 u32 flavor; /* (u32)(-1) used to mean "no valid flavor" */
Eric W. Biederman03bc6d12013-02-02 06:24:49 -0800156 kuid_t uid;
157 kgid_t gid;
J. Bruce Fieldsacb28872012-03-27 14:50:26 -0400158};
159
Andy Adamson49557cc2009-07-23 19:02:16 -0400160struct nfsd4_create_session {
161 clientid_t clientid;
162 struct nfs4_sessionid sessionid;
163 u32 seqid;
164 u32 flags;
165 struct nfsd4_channel_attrs fore_channel;
166 struct nfsd4_channel_attrs back_channel;
167 u32 callback_prog;
J. Bruce Fieldsacb28872012-03-27 14:50:26 -0400168 struct nfsd4_cb_sec cb_sec;
Andy Adamson49557cc2009-07-23 19:02:16 -0400169};
170
J. Bruce Fieldscb73a9f2012-11-01 18:09:48 -0400171struct nfsd4_backchannel_ctl {
172 u32 bc_cb_program;
173 struct nfsd4_cb_sec bc_cb_sec;
174};
175
J. Bruce Fields1d1bc8f2010-10-04 23:12:59 -0400176struct nfsd4_bind_conn_to_session {
177 struct nfs4_sessionid sessionid;
178 u32 dir;
179};
180
Andy Adamson49557cc2009-07-23 19:02:16 -0400181/* The single slot clientid cache structure */
182struct nfsd4_clid_slot {
183 u32 sl_seqid;
184 __be32 sl_status;
185 struct nfsd4_create_session sl_cr_ses;
186};
187
J. Bruce Fieldsc7662512010-06-06 18:12:14 -0400188struct nfsd4_conn {
189 struct list_head cn_persession;
190 struct svc_xprt *cn_xprt;
J. Bruce Fields19cf5c02010-06-06 18:37:16 -0400191 struct svc_xpt_user cn_xpt_user;
192 struct nfsd4_session *cn_session;
J. Bruce Fieldsc7662512010-06-06 18:12:14 -0400193/* CDFC4_FORE, CDFC4_BACK: */
194 unsigned char cn_flags;
195};
196
Andy Adamson7116ed62009-04-03 08:27:43 +0300197struct nfsd4_session {
J. Bruce Fields66b2b9b2013-03-19 12:05:39 -0400198 atomic_t se_ref;
Andy Adamson7116ed62009-04-03 08:27:43 +0300199 struct list_head se_hash; /* hash by sessionid */
200 struct list_head se_perclnt;
J. Bruce Fields66b2b9b2013-03-19 12:05:39 -0400201/* See SESSION4_PERSIST, etc. for standard flags; this is internal-only: */
202#define NFS4_SESSION_DEAD 0x010
Andy Adamson7116ed62009-04-03 08:27:43 +0300203 u32 se_flags;
Benny Halevy07cd4902010-05-12 00:13:41 +0300204 struct nfs4_client *se_client;
Andy Adamson7116ed62009-04-03 08:27:43 +0300205 struct nfs4_sessionid se_sessionid;
Alexandros Batsakis6c18ba92009-06-16 04:19:13 +0300206 struct nfsd4_channel_attrs se_fchannel;
207 struct nfsd4_channel_attrs se_bchannel;
J. Bruce Fieldsacb28872012-03-27 14:50:26 -0400208 struct nfsd4_cb_sec se_cb_sec;
J. Bruce Fieldsc7662512010-06-06 18:12:14 -0400209 struct list_head se_conns;
J. Bruce Fields8b5ce5c2010-10-19 17:31:50 -0400210 u32 se_cb_prog;
J. Bruce Fieldsac7c46f2010-06-14 19:01:57 -0400211 u32 se_cb_seq_nr;
Andy Adamson557ce262009-08-28 08:45:04 -0400212 struct nfsd4_slot *se_slots[]; /* forward channel slots */
Andy Adamson7116ed62009-04-03 08:27:43 +0300213};
214
J. Bruce Fields221a6872013-04-01 22:23:49 -0400215extern void nfsd4_put_session(struct nfsd4_session *ses);
216
Marc Eshel5282fd72009-04-03 08:27:52 +0300217/* formatted contents of nfs4_sessionid */
218struct nfsd4_sessionid {
219 clientid_t clientid;
220 u32 sequence;
221 u32 reserved;
222};
223
NeilBrowna55370a2005-06-23 22:03:52 -0700224#define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */
225
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226/*
227 * struct nfs4_client - one per client. Clientids live here.
228 * o Each nfs4_client is hashed by clientid.
229 *
230 * o Each nfs4_clients is also hashed by name
231 * (the opaque quantity initially sent by the client to identify itself).
232 *
233 * o cl_perclient list is used to ensure no dangling stateowner references
234 * when we expire the nfs4_client
235 */
236struct nfs4_client {
237 struct list_head cl_idhash; /* hash by cl_clientid.id */
Jeff Laytonac55fdc2012-11-12 15:00:56 -0500238 struct rb_node cl_namenode; /* link into by-name trees */
NeilBrownea1da632005-06-23 22:04:17 -0700239 struct list_head cl_openowners;
J. Bruce Fields38c2f4b2011-09-23 17:01:19 -0400240 struct idr cl_stateids; /* stateid lookup */
NeilBrownea1da632005-06-23 22:04:17 -0700241 struct list_head cl_delegations;
J. Bruce Fields3bd64a52013-04-09 17:02:51 -0400242 struct list_head cl_revoked; /* unacknowledged, revoked 4.1 state */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 struct list_head cl_lru; /* tail queue */
244 struct xdr_netobj cl_name; /* id generated by client */
245 nfs4_verifier cl_verifier; /* generated by client */
246 time_t cl_time; /* time of last lease renewal */
Jeff Layton363168b2009-08-14 12:57:56 -0400247 struct sockaddr_storage cl_addr; /* client ipaddress */
J. Bruce Fields57266a62013-04-13 14:27:29 -0400248 bool cl_mach_cred; /* SP4_MACH_CRED in force */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 struct svc_cred cl_cred; /* setclientid principal */
250 clientid_t cl_clientid; /* generated by server */
251 nfs4_verifier cl_confirm; /* generated by server */
J. Bruce Fields8323c3b2010-10-19 19:36:51 -0400252 u32 cl_minorversion;
Marc Eshel9fb87072009-04-03 08:27:46 +0300253
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500254 /* for v4.0 and v4.1 callbacks: */
255 struct nfs4_cb_conn cl_cb_conn;
Jeff Laytona52d7262012-03-21 09:52:02 -0400256#define NFSD4_CLIENT_CB_UPDATE (0)
257#define NFSD4_CLIENT_CB_KILL (1)
258#define NFSD4_CLIENT_STABLE (2) /* client on stable storage */
259#define NFSD4_CLIENT_RECLAIM_COMPLETE (3) /* reclaim_complete done */
Jeff Laytonac55fdc2012-11-12 15:00:56 -0500260#define NFSD4_CLIENT_CONFIRMED (4) /* client is confirmed */
Jeff Laytona52d7262012-03-21 09:52:02 -0400261#define NFSD4_CLIENT_CB_FLAG_MASK (1 << NFSD4_CLIENT_CB_UPDATE | \
262 1 << NFSD4_CLIENT_CB_KILL)
263 unsigned long cl_flags;
J. Bruce Fieldsc6bb3ca2012-11-01 16:31:02 -0400264 struct rpc_cred *cl_cb_cred;
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500265 struct rpc_clnt *cl_cb_client;
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400266 u32 cl_cb_ident;
J. Bruce Fields77a35692010-04-30 18:51:44 -0400267#define NFSD4_CB_UP 0
268#define NFSD4_CB_UNKNOWN 1
269#define NFSD4_CB_DOWN 2
Benny Halevy54237322011-10-19 19:12:58 -0700270#define NFSD4_CB_FAULT 3
J. Bruce Fields77a35692010-04-30 18:51:44 -0400271 int cl_cb_state;
J. Bruce Fieldscee277d2010-05-26 17:52:14 -0400272 struct nfsd4_callback cl_cb_null;
J. Bruce Fieldsedd76782010-06-14 22:26:31 -0400273 struct nfsd4_session *cl_cb_session;
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -0500274 struct list_head cl_callbacks; /* list of in-progress callbacks */
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500275
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400276 /* for all client information that callback code might need: */
277 spinlock_t cl_lock;
278
Marc Eshel9fb87072009-04-03 08:27:46 +0300279 /* for nfs41 */
280 struct list_head cl_sessions;
Andy Adamson49557cc2009-07-23 19:02:16 -0400281 struct nfsd4_clid_slot cl_cs_slot; /* create_session slot */
Andy Adamson0733d212009-04-03 08:28:01 +0300282 u32 cl_exchange_flags;
Benny Halevy46583e22010-05-12 00:13:29 +0300283 /* number of rpc's in progress over an associated session: */
284 atomic_t cl_refcount;
Andy Adamson38524ab2009-09-10 12:25:59 +0300285
286 /* for nfs41 callbacks */
Ricardo Labiaga199ff352009-09-10 12:26:25 +0300287 /* We currently support a single back channel with a single slot */
288 unsigned long cl_cb_slot_busy;
Ricardo Labiaga199ff352009-09-10 12:26:25 +0300289 struct rpc_wait_queue cl_cb_waitq; /* backchannel callers may */
290 /* wait here for slots */
Stanislav Kinsburskyc212cec2012-11-14 18:21:10 +0300291 struct net *net;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292};
293
294/* struct nfs4_client_reset
295 * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
296 * upon lease reset, or from upcall to state_daemon (to read in state
297 * from non-volitile storage) upon reboot.
298 */
299struct nfs4_client_reclaim {
300 struct list_head cr_strhash; /* hash by cr_name */
Jeff Layton0ce0c2b2012-11-12 15:00:55 -0500301 struct nfs4_client *cr_clp; /* pointer to associated clp */
NeilBrowna55370a2005-06-23 22:03:52 -0700302 char cr_recdir[HEXDIR_LEN]; /* recover dir */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303};
304
305static inline void
306update_stateid(stateid_t *stateid)
307{
308 stateid->si_generation++;
J. Bruce Fields81b82962011-08-23 11:03:29 -0400309 /* Wraparound recommendation from 3530bis-13 9.1.3.2: */
310 if (stateid->si_generation == 0)
311 stateid->si_generation = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312}
313
314/* A reasonable value for REPLAY_ISIZE was estimated as follows:
315 * The OPEN response, typically the largest, requires
316 * 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) +
317 * 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
318 * 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
319 */
320
321#define NFSD4_REPLAY_ISIZE 112
322
323/*
324 * Replay buffer, where the result of the last seqid-mutating operation
325 * is cached.
326 */
327struct nfs4_replay {
Al Virob37ad282006-10-19 23:28:59 -0700328 __be32 rp_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 unsigned int rp_buflen;
330 char *rp_buf;
J. Bruce Fieldsa4773c082009-02-02 17:23:10 -0500331 struct knfsd_fh rp_openfh;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332 char rp_ibuf[NFSD4_REPLAY_ISIZE];
333};
334
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335struct nfs4_stateowner {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 struct list_head so_strhash; /* hash by op_name */
NeilBrownea1da632005-06-23 22:04:17 -0700337 struct list_head so_stateids;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338 struct nfs4_client * so_client;
NeilBrown7fb64ce2005-07-07 17:59:20 -0700339 /* after increment in ENCODE_SEQID_OP_TAIL, represents the next
340 * sequence id expected from the client: */
341 u32 so_seqid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 struct xdr_netobj so_owner; /* open owner name */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 struct nfs4_replay so_replay;
J. Bruce Fields3557e432011-10-12 16:58:21 -0400344 bool so_is_open_owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345};
346
J. Bruce Fieldsfe0750e2011-07-30 23:33:59 -0400347struct nfs4_openowner {
348 struct nfs4_stateowner oo_owner; /* must be first field */
349 struct list_head oo_perclient;
J. Bruce Fieldsb31b30e2011-09-28 11:47:20 -0400350 /*
351 * We keep around openowners a little while after last close,
352 * which saves clients from having to confirm, and allows us to
353 * handle close replays if they come soon enough. The close_lru
354 * is a list of such openowners, to be reaped by the laundromat
355 * thread eventually if they remain unused:
356 */
357 struct list_head oo_close_lru;
J. Bruce Fields38c387b2011-09-16 17:42:48 -0400358 struct nfs4_ol_stateid *oo_last_closed_stid;
J. Bruce Fieldsfe0750e2011-07-30 23:33:59 -0400359 time_t oo_time; /* time of placement on so_close_lru */
J. Bruce Fieldsdad1c062011-09-12 12:24:13 -0400360#define NFS4_OO_CONFIRMED 1
J. Bruce Fieldsd29b20c2011-10-13 15:12:59 -0400361#define NFS4_OO_NEW 4
J. Bruce Fieldsdad1c062011-09-12 12:24:13 -0400362 unsigned char oo_flags;
J. Bruce Fieldsfe0750e2011-07-30 23:33:59 -0400363};
364
365struct nfs4_lockowner {
366 struct nfs4_stateowner lo_owner; /* must be first element */
J. Bruce Fields009673b2011-11-07 17:40:10 -0500367 struct list_head lo_owner_ino_hash; /* hash by owner,file */
J. Bruce Fields9411b1d2013-04-01 16:37:12 -0400368 struct list_head lo_perstateid;
J. Bruce Fieldsfe0750e2011-07-30 23:33:59 -0400369 struct list_head lo_list; /* for temporary uses */
370};
371
372static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so)
373{
374 return container_of(so, struct nfs4_openowner, oo_owner);
375}
376
377static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so)
378{
379 return container_of(so, struct nfs4_lockowner, lo_owner);
380}
381
Jeff Layton1696c472012-08-06 11:00:27 -0400382/* nfs4_file: a file opened by some number of (open) nfs4_stateowners. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383struct nfs4_file {
J. Bruce Fields8b671b82009-02-22 14:51:34 -0800384 atomic_t fi_ref;
Jeff Layton89876f82013-04-02 09:01:59 -0400385 struct hlist_node 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;
Stanislav Kinsbursky2c142ba2012-07-25 16:57:45 +0400454struct nfsd_net;
Benny Halevydd453df2009-04-03 08:28:41 +0300455
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400456extern __be32 nfs4_preprocess_stateid_op(struct net *net,
457 struct nfsd4_compound_state *cstate,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 stateid_t *stateid, int flags, struct file **filp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459extern void nfs4_lock_state(void);
460extern void nfs4_unlock_state(void);
Stanislav Kinsbursky52e19c02012-11-14 18:21:16 +0300461void nfs4_remove_reclaim_record(struct nfs4_client_reclaim *, struct nfsd_net *);
462extern void nfs4_release_reclaim(struct nfsd_net *);
463extern struct nfs4_client_reclaim *nfsd4_find_reclaim_client(const char *recdir,
464 struct nfsd_net *nn);
Stanislav Kinsbursky3320fef192012-11-14 18:22:07 +0300465extern __be32 nfs4_check_open_reclaim(clientid_t *clid, bool sessions, struct nfsd_net *nn);
J. Bruce Fields80fc0152009-09-15 18:07:35 -0400466extern int set_callback_cred(void);
J. Bruce Fields57725152012-11-05 15:10:26 -0500467extern void nfsd4_init_callback(struct nfsd4_callback *);
J. Bruce Fields5a3c9d72010-10-19 17:56:52 -0400468extern void nfsd4_probe_callback(struct nfs4_client *clp);
J. Bruce Fields84f5f7c2010-12-09 15:52:19 -0500469extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
J. Bruce Fields5a3c9d72010-10-19 17:56:52 -0400470extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -0500472extern int nfsd4_create_callback_queue(void);
473extern void nfsd4_destroy_callback_queue(void);
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400474extern void nfsd4_shutdown_callback(struct nfs4_client *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475extern void nfs4_put_delegation(struct nfs4_delegation *dp);
Stanislav Kinsbursky52e19c02012-11-14 18:21:16 +0300476extern struct nfs4_client_reclaim *nfs4_client_to_reclaim(const char *name,
477 struct nfsd_net *nn);
478extern bool nfs4_has_reclaimed_state(const char *name, struct nfsd_net *nn);
J. Bruce Fields221a6872013-04-01 22:23:49 -0400479extern void put_client_renew(struct nfs4_client *clp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480
Jeff Layton2a4317c2012-03-21 16:42:43 -0400481/* nfs4recover operations */
482extern int nfsd4_client_tracking_init(struct net *net);
483extern void nfsd4_client_tracking_exit(struct net *net);
484extern void nfsd4_client_record_create(struct nfs4_client *clp);
485extern void nfsd4_client_record_remove(struct nfs4_client *clp);
486extern int nfsd4_client_record_check(struct nfs4_client *clp);
Stanislav Kinsbursky12760c62012-11-14 18:22:12 +0300487extern void nfsd4_record_grace_done(struct nfsd_net *nn, time_t boot_time);
Bryan Schumakerf3c75212012-11-27 09:35:10 -0500488
489/* nfs fault injection functions */
490#ifdef CONFIG_NFSD_FAULT_INJECTION
491int nfsd_fault_inject_init(void);
492void nfsd_fault_inject_cleanup(void);
Bryan Schumaker8ce54e02012-11-29 11:40:43 -0500493u64 nfsd_for_n_state(u64, u64 (*)(struct nfs4_client *, u64));
Bryan Schumaker6c1e82a2012-11-29 11:40:46 -0500494struct nfs4_client *nfsd_find_client(struct sockaddr_storage *, size_t);
Bryan Schumaker8ce54e02012-11-29 11:40:43 -0500495
496u64 nfsd_forget_client(struct nfs4_client *, u64);
497u64 nfsd_forget_client_locks(struct nfs4_client*, u64);
498u64 nfsd_forget_client_openowners(struct nfs4_client *, u64);
499u64 nfsd_forget_client_delegations(struct nfs4_client *, u64);
500u64 nfsd_recall_client_delegations(struct nfs4_client *, u64);
Bryan Schumaker184c1842012-11-29 11:40:44 -0500501
502u64 nfsd_print_client(struct nfs4_client *, u64);
503u64 nfsd_print_client_locks(struct nfs4_client *, u64);
504u64 nfsd_print_client_openowners(struct nfs4_client *, u64);
505u64 nfsd_print_client_delegations(struct nfs4_client *, u64);
Bryan Schumakerf3c75212012-11-27 09:35:10 -0500506#else /* CONFIG_NFSD_FAULT_INJECTION */
507static inline int nfsd_fault_inject_init(void) { return 0; }
508static inline void nfsd_fault_inject_cleanup(void) {}
509#endif /* CONFIG_NFSD_FAULT_INJECTION */
510
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511#endif /* NFSD4_STATE_H */