blob: 4a89e00d7461c8658293504e14c3c5646b5ff240 [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
Jeff Layton14a571a2014-08-05 15:13:30 -040075/*
76 * A core object that represents a "common" stateid. These are generally
77 * embedded within the different (more specific) stateid objects and contain
78 * fields that are of general use to any stateid.
79 */
J. Bruce Fieldsd5477a82011-09-08 12:07:44 -040080struct nfs4_stid {
Trond Myklebust72c0b0f2014-07-21 09:34:58 -040081 atomic_t sc_count;
J. Bruce Fieldsd5477a82011-09-08 12:07:44 -040082#define NFS4_OPEN_STID 1
83#define NFS4_LOCK_STID 2
84#define NFS4_DELEG_STID 4
J. Bruce Fieldsf7a4d872011-09-16 20:12:38 -040085/* For an open stateid kept around *only* to process close replays: */
86#define NFS4_CLOSED_STID 8
J. Bruce Fields3bd64a52013-04-09 17:02:51 -040087/* For a deleg stateid kept around only to process free_stateid's: */
88#define NFS4_REVOKED_DELEG_STID 16
Trond Myklebustb0fc29d2014-07-16 10:31:59 -040089#define NFS4_CLOSED_DELEG_STID 32
J. Bruce Fieldsf7a4d872011-09-16 20:12:38 -040090 unsigned char sc_type;
J. Bruce Fieldsd5477a82011-09-08 12:07:44 -040091 stateid_t sc_stateid;
J. Bruce Fields2a74aba2011-09-23 17:20:02 -040092 struct nfs4_client *sc_client;
Trond Myklebust11b91642014-07-29 21:34:08 -040093 struct nfs4_file *sc_file;
Trond Myklebust60116952014-07-29 21:34:06 -040094 void (*sc_free)(struct nfs4_stid *);
J. Bruce Fieldsd5477a82011-09-08 12:07:44 -040095};
96
Jeff Layton14a571a2014-08-05 15:13:30 -040097/*
98 * Represents a delegation stateid. The nfs4_client holds references to these
99 * and they are put when it is being destroyed or when the delegation is
100 * returned by the client:
101 *
102 * o 1 reference as long as a delegation is still in force (taken when it's
103 * alloc'd, put when it's returned or revoked)
104 *
105 * o 1 reference as long as a recall rpc is in progress (taken when the lease
106 * is broken, put when the rpc exits)
107 *
108 * o 1 more ephemeral reference for each nfsd thread currently doing something
109 * with that delegation without holding the cl_lock
110 *
111 * If the server attempts to recall a delegation and the client doesn't do so
112 * before a timeout, the server may also revoke the delegation. In that case,
113 * the object will either be destroyed (v4.0) or moved to a per-client list of
114 * revoked delegations (v4.1+).
115 *
116 * This object is a superset of the nfs4_stid.
117 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118struct nfs4_delegation {
J. Bruce Fields996e0932011-10-17 11:14:48 -0400119 struct nfs4_stid dl_stid; /* must be first field */
NeilBrownea1da632005-06-23 22:04:17 -0700120 struct list_head dl_perfile;
121 struct list_head dl_perclnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 struct list_head dl_recall_lru; /* delegation recalled */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123 u32 dl_type;
124 time_t dl_time;
J. Bruce Fieldsb53d40c2009-05-01 19:50:00 -0400125/* For recall: */
J. Bruce Fields3aea09d2009-05-01 20:11:12 -0400126 int dl_retries;
J. Bruce Fields227f98d92010-02-18 08:27:24 -0800127 struct nfsd4_callback dl_recall;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128};
129
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130/* client delegation callback info */
J. Bruce Fieldsc237dc02009-04-29 19:09:19 -0400131struct nfs4_cb_conn {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 /* SETCLIENTID info */
Jeff Laytonaa9a4ec2009-08-14 12:57:57 -0400133 struct sockaddr_storage cb_addr;
Takuma Umeya6f3d7722010-12-15 14:09:01 +0900134 struct sockaddr_storage cb_saddr;
Jeff Laytonaa9a4ec2009-08-14 12:57:57 -0400135 size_t cb_addrlen;
J. Bruce Fields8b5ce5c2010-10-19 17:31:50 -0400136 u32 cb_prog; /* used only in 4.0 case;
137 per-session otherwise */
Andy Adamsonab52ae62009-06-16 04:20:53 +0300138 u32 cb_ident; /* minorversion 0 only */
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500139 struct svc_xprt *cb_xprt; /* minorversion 1 only */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140};
141
J. Bruce Fieldsf459e452011-09-09 09:06:12 -0400142static inline struct nfs4_delegation *delegstateid(struct nfs4_stid *s)
143{
144 return container_of(s, struct nfs4_delegation, dl_stid);
145}
146
Andy Adamsona6496372009-08-28 08:45:01 -0400147/* Maximum number of slots per session. 160 is useful for long haul TCP */
148#define NFSD_MAX_SLOTS_PER_SESSION 160
Andy Adamsonec6b5d72009-04-03 08:28:28 +0300149/* Maximum number of operations per session compound */
150#define NFSD_MAX_OPS_PER_COMPOUND 16
Andy Adamson557ce262009-08-28 08:45:04 -0400151/* Maximum session per slot cache size */
J. Bruce Fields24906f32014-03-12 15:17:18 -0400152#define NFSD_SLOT_CACHE_SIZE 2048
Andy Adamsona6496372009-08-28 08:45:01 -0400153/* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
154#define NFSD_CACHE_SIZE_SLOTS_PER_SESSION 32
155#define NFSD_MAX_MEM_PER_SESSION \
156 (NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
Andy Adamson074fe892009-04-03 08:28:15 +0300157
Andy Adamson7116ed62009-04-03 08:27:43 +0300158struct nfsd4_slot {
Andy Adamson557ce262009-08-28 08:45:04 -0400159 u32 sl_seqid;
160 __be32 sl_status;
161 u32 sl_datalen;
J. Bruce Fields73e79482012-02-13 16:39:00 -0500162 u16 sl_opcnt;
163#define NFSD4_SLOT_INUSE (1 << 0)
164#define NFSD4_SLOT_CACHETHIS (1 << 1)
J. Bruce Fieldsbf5c43c2012-02-13 16:56:19 -0500165#define NFSD4_SLOT_INITIALIZED (1 << 2)
J. Bruce Fields73e79482012-02-13 16:39:00 -0500166 u8 sl_flags;
Andy Adamson557ce262009-08-28 08:45:04 -0400167 char sl_data[];
Andy Adamson7116ed62009-04-03 08:27:43 +0300168};
169
Alexandros Batsakis6c18ba92009-06-16 04:19:13 +0300170struct nfsd4_channel_attrs {
171 u32 headerpadsz;
172 u32 maxreq_sz;
173 u32 maxresp_sz;
174 u32 maxresp_cached;
175 u32 maxops;
176 u32 maxreqs;
177 u32 nr_rdma_attrs;
178 u32 rdma_attrs;
179};
180
J. Bruce Fieldsacb28872012-03-27 14:50:26 -0400181struct nfsd4_cb_sec {
J. Bruce Fields12fc3e92012-11-05 16:01:48 -0500182 u32 flavor; /* (u32)(-1) used to mean "no valid flavor" */
Eric W. Biederman03bc6d12013-02-02 06:24:49 -0800183 kuid_t uid;
184 kgid_t gid;
J. Bruce Fieldsacb28872012-03-27 14:50:26 -0400185};
186
Andy Adamson49557cc2009-07-23 19:02:16 -0400187struct nfsd4_create_session {
188 clientid_t clientid;
189 struct nfs4_sessionid sessionid;
190 u32 seqid;
191 u32 flags;
192 struct nfsd4_channel_attrs fore_channel;
193 struct nfsd4_channel_attrs back_channel;
194 u32 callback_prog;
J. Bruce Fieldsacb28872012-03-27 14:50:26 -0400195 struct nfsd4_cb_sec cb_sec;
Andy Adamson49557cc2009-07-23 19:02:16 -0400196};
197
J. Bruce Fieldscb73a9f2012-11-01 18:09:48 -0400198struct nfsd4_backchannel_ctl {
199 u32 bc_cb_program;
200 struct nfsd4_cb_sec bc_cb_sec;
201};
202
J. Bruce Fields1d1bc8f2010-10-04 23:12:59 -0400203struct nfsd4_bind_conn_to_session {
204 struct nfs4_sessionid sessionid;
205 u32 dir;
206};
207
Andy Adamson49557cc2009-07-23 19:02:16 -0400208/* The single slot clientid cache structure */
209struct nfsd4_clid_slot {
210 u32 sl_seqid;
211 __be32 sl_status;
212 struct nfsd4_create_session sl_cr_ses;
213};
214
J. Bruce Fieldsc7662512010-06-06 18:12:14 -0400215struct nfsd4_conn {
216 struct list_head cn_persession;
217 struct svc_xprt *cn_xprt;
J. Bruce Fields19cf5c02010-06-06 18:37:16 -0400218 struct svc_xpt_user cn_xpt_user;
219 struct nfsd4_session *cn_session;
J. Bruce Fieldsc7662512010-06-06 18:12:14 -0400220/* CDFC4_FORE, CDFC4_BACK: */
221 unsigned char cn_flags;
222};
223
Jeff Layton14a571a2014-08-05 15:13:30 -0400224/*
225 * Representation of a v4.1+ session. These are refcounted in a similar fashion
226 * to the nfs4_client. References are only taken when the server is actively
227 * working on the object (primarily during the processing of compounds).
228 */
Andy Adamson7116ed62009-04-03 08:27:43 +0300229struct nfsd4_session {
J. Bruce Fields66b2b9b2013-03-19 12:05:39 -0400230 atomic_t se_ref;
Andy Adamson7116ed62009-04-03 08:27:43 +0300231 struct list_head se_hash; /* hash by sessionid */
232 struct list_head se_perclnt;
J. Bruce Fields66b2b9b2013-03-19 12:05:39 -0400233/* See SESSION4_PERSIST, etc. for standard flags; this is internal-only: */
234#define NFS4_SESSION_DEAD 0x010
Andy Adamson7116ed62009-04-03 08:27:43 +0300235 u32 se_flags;
Benny Halevy07cd4902010-05-12 00:13:41 +0300236 struct nfs4_client *se_client;
Andy Adamson7116ed62009-04-03 08:27:43 +0300237 struct nfs4_sessionid se_sessionid;
Alexandros Batsakis6c18ba92009-06-16 04:19:13 +0300238 struct nfsd4_channel_attrs se_fchannel;
239 struct nfsd4_channel_attrs se_bchannel;
J. Bruce Fieldsacb28872012-03-27 14:50:26 -0400240 struct nfsd4_cb_sec se_cb_sec;
J. Bruce Fieldsc7662512010-06-06 18:12:14 -0400241 struct list_head se_conns;
J. Bruce Fields8b5ce5c2010-10-19 17:31:50 -0400242 u32 se_cb_prog;
J. Bruce Fieldsac7c46f2010-06-14 19:01:57 -0400243 u32 se_cb_seq_nr;
Andy Adamson557ce262009-08-28 08:45:04 -0400244 struct nfsd4_slot *se_slots[]; /* forward channel slots */
Andy Adamson7116ed62009-04-03 08:27:43 +0300245};
246
Marc Eshel5282fd72009-04-03 08:27:52 +0300247/* formatted contents of nfs4_sessionid */
248struct nfsd4_sessionid {
249 clientid_t clientid;
250 u32 sequence;
251 u32 reserved;
252};
253
NeilBrowna55370a2005-06-23 22:03:52 -0700254#define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */
255
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256/*
257 * struct nfs4_client - one per client. Clientids live here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 *
Jeff Layton14a571a2014-08-05 15:13:30 -0400259 * The initial object created by an NFS client using SETCLIENTID (for NFSv4.0)
260 * or EXCHANGE_ID (for NFSv4.1+). These objects are refcounted and timestamped.
261 * Each nfsd_net_ns object contains a set of these and they are tracked via
262 * short and long form clientid. They are hashed and searched for under the
263 * per-nfsd_net client_lock spinlock.
264 *
265 * References to it are only held during the processing of compounds, and in
266 * certain other operations. In their "resting state" they have a refcount of
267 * 0. If they are not renewed within a lease period, they become eligible for
268 * destruction by the laundromat.
269 *
270 * These objects can also be destroyed prematurely by the fault injection code,
271 * or if the client sends certain forms of SETCLIENTID or EXCHANGE_ID updates.
272 * Care is taken *not* to do this however when the objects have an elevated
273 * refcount.
274 *
275 * o Each nfs4_client is hashed by clientid
276 *
277 * o Each nfs4_clients is also hashed by name (the opaque quantity initially
278 * sent by the client to identify itself).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 *
Jeff Layton14a571a2014-08-05 15:13:30 -0400280 * o cl_perclient list is used to ensure no dangling stateowner references
281 * when we expire the nfs4_client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 */
283struct nfs4_client {
284 struct list_head cl_idhash; /* hash by cl_clientid.id */
Jeff Laytonac55fdc2012-11-12 15:00:56 -0500285 struct rb_node cl_namenode; /* link into by-name trees */
Trond Myklebustd4f04892014-07-29 21:34:36 -0400286 struct list_head *cl_ownerstr_hashtbl;
NeilBrownea1da632005-06-23 22:04:17 -0700287 struct list_head cl_openowners;
J. Bruce Fields38c2f4b2011-09-23 17:01:19 -0400288 struct idr cl_stateids; /* stateid lookup */
NeilBrownea1da632005-06-23 22:04:17 -0700289 struct list_head cl_delegations;
J. Bruce Fields3bd64a52013-04-09 17:02:51 -0400290 struct list_head cl_revoked; /* unacknowledged, revoked 4.1 state */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 struct list_head cl_lru; /* tail queue */
292 struct xdr_netobj cl_name; /* id generated by client */
293 nfs4_verifier cl_verifier; /* generated by client */
294 time_t cl_time; /* time of last lease renewal */
Jeff Layton363168b2009-08-14 12:57:56 -0400295 struct sockaddr_storage cl_addr; /* client ipaddress */
J. Bruce Fields57266a62013-04-13 14:27:29 -0400296 bool cl_mach_cred; /* SP4_MACH_CRED in force */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 struct svc_cred cl_cred; /* setclientid principal */
298 clientid_t cl_clientid; /* generated by server */
299 nfs4_verifier cl_confirm; /* generated by server */
J. Bruce Fields8323c3b2010-10-19 19:36:51 -0400300 u32 cl_minorversion;
Marc Eshel9fb87072009-04-03 08:27:46 +0300301
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500302 /* for v4.0 and v4.1 callbacks: */
303 struct nfs4_cb_conn cl_cb_conn;
Jeff Laytona52d7262012-03-21 09:52:02 -0400304#define NFSD4_CLIENT_CB_UPDATE (0)
305#define NFSD4_CLIENT_CB_KILL (1)
306#define NFSD4_CLIENT_STABLE (2) /* client on stable storage */
307#define NFSD4_CLIENT_RECLAIM_COMPLETE (3) /* reclaim_complete done */
Jeff Laytonac55fdc2012-11-12 15:00:56 -0500308#define NFSD4_CLIENT_CONFIRMED (4) /* client is confirmed */
Jeff Laytona52d7262012-03-21 09:52:02 -0400309#define NFSD4_CLIENT_CB_FLAG_MASK (1 << NFSD4_CLIENT_CB_UPDATE | \
310 1 << NFSD4_CLIENT_CB_KILL)
311 unsigned long cl_flags;
J. Bruce Fieldsc6bb3ca2012-11-01 16:31:02 -0400312 struct rpc_cred *cl_cb_cred;
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500313 struct rpc_clnt *cl_cb_client;
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400314 u32 cl_cb_ident;
J. Bruce Fields77a35692010-04-30 18:51:44 -0400315#define NFSD4_CB_UP 0
316#define NFSD4_CB_UNKNOWN 1
317#define NFSD4_CB_DOWN 2
Benny Halevy54237322011-10-19 19:12:58 -0700318#define NFSD4_CB_FAULT 3
J. Bruce Fields77a35692010-04-30 18:51:44 -0400319 int cl_cb_state;
J. Bruce Fieldscee277d2010-05-26 17:52:14 -0400320 struct nfsd4_callback cl_cb_null;
J. Bruce Fieldsedd76782010-06-14 22:26:31 -0400321 struct nfsd4_session *cl_cb_session;
J. Bruce Fields5ce8ba22011-01-10 16:44:41 -0500322 struct list_head cl_callbacks; /* list of in-progress callbacks */
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500323
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400324 /* for all client information that callback code might need: */
325 spinlock_t cl_lock;
326
Marc Eshel9fb87072009-04-03 08:27:46 +0300327 /* for nfs41 */
328 struct list_head cl_sessions;
Andy Adamson49557cc2009-07-23 19:02:16 -0400329 struct nfsd4_clid_slot cl_cs_slot; /* create_session slot */
Andy Adamson0733d212009-04-03 08:28:01 +0300330 u32 cl_exchange_flags;
Benny Halevy46583e22010-05-12 00:13:29 +0300331 /* number of rpc's in progress over an associated session: */
332 atomic_t cl_refcount;
Andy Adamson38524ab2009-09-10 12:25:59 +0300333
334 /* for nfs41 callbacks */
Ricardo Labiaga199ff352009-09-10 12:26:25 +0300335 /* We currently support a single back channel with a single slot */
336 unsigned long cl_cb_slot_busy;
Ricardo Labiaga199ff352009-09-10 12:26:25 +0300337 struct rpc_wait_queue cl_cb_waitq; /* backchannel callers may */
338 /* wait here for slots */
Stanislav Kinsburskyc212cec2012-11-14 18:21:10 +0300339 struct net *net;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340};
341
342/* struct nfs4_client_reset
343 * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
344 * upon lease reset, or from upcall to state_daemon (to read in state
345 * from non-volitile storage) upon reboot.
346 */
347struct nfs4_client_reclaim {
348 struct list_head cr_strhash; /* hash by cr_name */
Jeff Layton0ce0c2b2012-11-12 15:00:55 -0500349 struct nfs4_client *cr_clp; /* pointer to associated clp */
NeilBrowna55370a2005-06-23 22:03:52 -0700350 char cr_recdir[HEXDIR_LEN]; /* recover dir */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351};
352
353static inline void
354update_stateid(stateid_t *stateid)
355{
356 stateid->si_generation++;
J. Bruce Fields81b82962011-08-23 11:03:29 -0400357 /* Wraparound recommendation from 3530bis-13 9.1.3.2: */
358 if (stateid->si_generation == 0)
359 stateid->si_generation = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360}
361
362/* A reasonable value for REPLAY_ISIZE was estimated as follows:
363 * The OPEN response, typically the largest, requires
364 * 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) +
365 * 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
366 * 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
367 */
368
369#define NFSD4_REPLAY_ISIZE 112
370
371/*
372 * Replay buffer, where the result of the last seqid-mutating operation
373 * is cached.
374 */
375struct nfs4_replay {
Al Virob37ad282006-10-19 23:28:59 -0700376 __be32 rp_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 unsigned int rp_buflen;
378 char *rp_buf;
J. Bruce Fieldsa4773c082009-02-02 17:23:10 -0500379 struct knfsd_fh rp_openfh;
Jeff Layton58fb12e2014-07-29 21:34:27 -0400380 struct mutex rp_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 char rp_ibuf[NFSD4_REPLAY_ISIZE];
382};
383
Jeff Layton6b180f02014-07-29 21:34:26 -0400384struct nfs4_stateowner;
385
386struct nfs4_stateowner_operations {
Jeff Layton8f4b54c2014-07-29 21:34:29 -0400387 void (*so_unhash)(struct nfs4_stateowner *);
Jeff Layton6b180f02014-07-29 21:34:26 -0400388 void (*so_free)(struct nfs4_stateowner *);
389};
390
Jeff Layton14a571a2014-08-05 15:13:30 -0400391/*
392 * A core object that represents either an open or lock owner. The object and
393 * lock owner objects have one of these embedded within them. Refcounts and
394 * other fields common to both owner types are contained within these
395 * structures.
396 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397struct nfs4_stateowner {
Jeff Layton6b180f02014-07-29 21:34:26 -0400398 struct list_head so_strhash;
399 struct list_head so_stateids;
400 struct nfs4_client *so_client;
401 const struct nfs4_stateowner_operations *so_ops;
J. Bruce Fields83e452f2014-07-31 16:10:08 -0400402 /* after increment in nfsd4_bump_seqid, represents the next
NeilBrown7fb64ce2005-07-07 17:59:20 -0700403 * sequence id expected from the client: */
Jeff Layton6b180f02014-07-29 21:34:26 -0400404 atomic_t so_count;
405 u32 so_seqid;
406 struct xdr_netobj so_owner; /* open owner name */
407 struct nfs4_replay so_replay;
408 bool so_is_open_owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409};
410
Jeff Layton14a571a2014-08-05 15:13:30 -0400411/*
412 * When a file is opened, the client provides an open state owner opaque string
413 * that indicates the "owner" of that open. These objects are refcounted.
414 * References to it are held by each open state associated with it. This object
415 * is a superset of the nfs4_stateowner struct.
416 */
J. Bruce Fieldsfe0750e2011-07-30 23:33:59 -0400417struct nfs4_openowner {
418 struct nfs4_stateowner oo_owner; /* must be first field */
419 struct list_head oo_perclient;
J. Bruce Fieldsb31b30e2011-09-28 11:47:20 -0400420 /*
421 * We keep around openowners a little while after last close,
422 * which saves clients from having to confirm, and allows us to
423 * handle close replays if they come soon enough. The close_lru
424 * is a list of such openowners, to be reaped by the laundromat
425 * thread eventually if they remain unused:
426 */
427 struct list_head oo_close_lru;
J. Bruce Fields38c387b2011-09-16 17:42:48 -0400428 struct nfs4_ol_stateid *oo_last_closed_stid;
J. Bruce Fieldsfe0750e2011-07-30 23:33:59 -0400429 time_t oo_time; /* time of placement on so_close_lru */
J. Bruce Fieldsdad1c062011-09-12 12:24:13 -0400430#define NFS4_OO_CONFIRMED 1
431 unsigned char oo_flags;
J. Bruce Fieldsfe0750e2011-07-30 23:33:59 -0400432};
433
Jeff Layton14a571a2014-08-05 15:13:30 -0400434/*
435 * Represents a generic "lockowner". Similar to an openowner. References to it
436 * are held by the lock stateids that are created on its behalf. This object is
437 * a superset of the nfs4_stateowner struct (or would be if it needed any extra
438 * fields).
439 */
J. Bruce Fieldsfe0750e2011-07-30 23:33:59 -0400440struct nfs4_lockowner {
441 struct nfs4_stateowner lo_owner; /* must be first element */
J. Bruce Fieldsfe0750e2011-07-30 23:33:59 -0400442};
443
444static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so)
445{
446 return container_of(so, struct nfs4_openowner, oo_owner);
447}
448
449static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so)
450{
451 return container_of(so, struct nfs4_lockowner, lo_owner);
452}
453
Jeff Layton14a571a2014-08-05 15:13:30 -0400454/*
455 * nfs4_file: a file opened by some number of (open) nfs4_stateowners.
456 *
457 * These objects are global. nfsd only keeps one instance of a nfs4_file per
458 * inode (though it may keep multiple file descriptors open per inode). These
459 * are tracked in the file_hashtbl which is protected by the state_lock
460 * spinlock.
461 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462struct nfs4_file {
J. Bruce Fields8b671b82009-02-22 14:51:34 -0800463 atomic_t fi_ref;
Trond Myklebust1d31a252014-07-10 14:07:25 -0400464 spinlock_t fi_lock;
Jeff Layton89876f82013-04-02 09:01:59 -0400465 struct hlist_node fi_hash; /* hash by "struct inode *" */
NeilBrown8beefa22005-06-23 22:03:08 -0700466 struct list_head fi_stateids;
467 struct list_head fi_delegations;
J. Bruce Fieldsf9d75622010-07-08 11:02:09 -0400468 /* One each for O_RDONLY, O_WRONLY, O_RDWR: */
469 struct file * fi_fds[3];
J. Bruce Fieldsf9d75622010-07-08 11:02:09 -0400470 /*
J. Bruce Fields6409a5a2011-09-28 11:37:56 -0400471 * Each open or lock stateid contributes 0-4 to the counts
472 * below depending on which bits are set in st_access_bitmap:
473 * 1 to fi_access[O_RDONLY] if NFS4_SHARE_ACCES_READ is set
474 * + 1 to fi_access[O_WRONLY] if NFS4_SHARE_ACCESS_WRITE is set
475 * + 1 to both of the above if NFS4_SHARE_ACCESS_BOTH is set.
J. Bruce Fieldsf9d75622010-07-08 11:02:09 -0400476 */
J. Bruce Fields9ae78bc2011-03-17 12:52:33 -0400477 atomic_t fi_access[2];
Jeff Laytonbaeb4ff2014-07-10 14:07:34 -0400478 u32 fi_share_deny;
J. Bruce Fieldsacfdf5c2011-01-31 19:20:39 -0500479 struct file *fi_deleg_file;
480 struct file_lock *fi_lease;
481 atomic_t fi_delegees;
Trond Myklebuste2cf80d2014-07-23 16:17:38 -0400482 struct knfsd_fh fi_fhandle;
Meelap Shah47f99402007-07-17 04:04:40 -0700483 bool fi_had_conflict;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484};
485
Jeff Layton14a571a2014-08-05 15:13:30 -0400486/*
487 * A generic struct representing either a open or lock stateid. The nfs4_client
488 * holds a reference to each of these objects, and they in turn hold a
489 * reference to their respective stateowners. The client's reference is
490 * released in response to a close or unlock (depending on whether it's an open
491 * or lock stateid) or when the client is being destroyed.
492 *
493 * In the case of v4.0 open stateids, these objects are preserved for a little
494 * while after close in order to handle CLOSE replays. Those are eventually
495 * reclaimed via a LRU scheme by the laundromat.
496 *
497 * This object is a superset of the nfs4_stid. "ol" stands for "Open or Lock".
498 * Better suggestions welcome.
499 */
J. Bruce Fieldsdcef0412011-09-07 16:06:42 -0400500struct nfs4_ol_stateid {
J. Bruce Fields996e0932011-10-17 11:14:48 -0400501 struct nfs4_stid st_stid; /* must be first field */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 struct list_head st_perfile;
NeilBrownea1da632005-06-23 22:04:17 -0700503 struct list_head st_perstateowner;
Trond Myklebust3c87b9b2014-06-30 11:48:38 -0400504 struct list_head st_locks;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 struct nfs4_stateowner * st_stateowner;
Jeff Laytonc11c5912014-07-10 14:07:30 -0400506 unsigned char st_access_bmap;
507 unsigned char st_deny_bmap;
J. Bruce Fieldsdcef0412011-09-07 16:06:42 -0400508 struct nfs4_ol_stateid * st_openstp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509};
510
J. Bruce Fieldsdcef0412011-09-07 16:06:42 -0400511static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s)
512{
513 return container_of(s, struct nfs4_ol_stateid, st_stid);
514}
515
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516/* flags for preprocess_seqid_op() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517#define RD_STATE 0x00000010
518#define WR_STATE 0x00000020
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519
Benny Halevydd453df2009-04-03 08:28:41 +0300520struct nfsd4_compound_state;
Stanislav Kinsbursky2c142ba2012-07-25 16:57:45 +0400521struct nfsd_net;
Benny Halevydd453df2009-04-03 08:28:41 +0300522
Stanislav Kinsbursky5ccb0062012-07-25 16:57:22 +0400523extern __be32 nfs4_preprocess_stateid_op(struct net *net,
524 struct nfsd4_compound_state *cstate,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 stateid_t *stateid, int flags, struct file **filp);
Trond Myklebust60116952014-07-29 21:34:06 -0400526void nfs4_put_stid(struct nfs4_stid *s);
Stanislav Kinsbursky52e19c02012-11-14 18:21:16 +0300527void nfs4_remove_reclaim_record(struct nfs4_client_reclaim *, struct nfsd_net *);
528extern void nfs4_release_reclaim(struct nfsd_net *);
529extern struct nfs4_client_reclaim *nfsd4_find_reclaim_client(const char *recdir,
530 struct nfsd_net *nn);
Trond Myklebust0fe492d2014-06-30 11:48:47 -0400531extern __be32 nfs4_check_open_reclaim(clientid_t *clid,
532 struct nfsd4_compound_state *cstate, struct nfsd_net *nn);
J. Bruce Fields80fc0152009-09-15 18:07:35 -0400533extern int set_callback_cred(void);
Jeff Layton02e12152014-07-16 10:31:57 -0400534void nfsd4_run_cb_null(struct work_struct *w);
535void nfsd4_run_cb_recall(struct work_struct *w);
J. Bruce Fields5a3c9d72010-10-19 17:56:52 -0400536extern void nfsd4_probe_callback(struct nfs4_client *clp);
J. Bruce Fields84f5f7c2010-12-09 15:52:19 -0500537extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
J. Bruce Fields5a3c9d72010-10-19 17:56:52 -0400538extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -0500540extern int nfsd4_create_callback_queue(void);
541extern void nfsd4_destroy_callback_queue(void);
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400542extern void nfsd4_shutdown_callback(struct nfs4_client *);
Jeff Layton02e12152014-07-16 10:31:57 -0400543extern void nfsd4_prepare_cb_recall(struct nfs4_delegation *dp);
Stanislav Kinsbursky52e19c02012-11-14 18:21:16 +0300544extern struct nfs4_client_reclaim *nfs4_client_to_reclaim(const char *name,
545 struct nfsd_net *nn);
546extern bool nfs4_has_reclaimed_state(const char *name, struct nfsd_net *nn);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547
Jeff Layton2a4317c2012-03-21 16:42:43 -0400548/* nfs4recover operations */
549extern int nfsd4_client_tracking_init(struct net *net);
550extern void nfsd4_client_tracking_exit(struct net *net);
551extern void nfsd4_client_record_create(struct nfs4_client *clp);
552extern void nfsd4_client_record_remove(struct nfs4_client *clp);
553extern int nfsd4_client_record_check(struct nfs4_client *clp);
Stanislav Kinsbursky12760c62012-11-14 18:22:12 +0300554extern void nfsd4_record_grace_done(struct nfsd_net *nn, time_t boot_time);
Bryan Schumakerf3c75212012-11-27 09:35:10 -0500555
556/* nfs fault injection functions */
557#ifdef CONFIG_NFSD_FAULT_INJECTION
558int nfsd_fault_inject_init(void);
559void nfsd_fault_inject_cleanup(void);
Bryan Schumaker8ce54e02012-11-29 11:40:43 -0500560
Jeff Layton285abde2014-07-30 08:27:24 -0400561u64 nfsd_inject_print_clients(void);
562u64 nfsd_inject_forget_client(struct sockaddr_storage *, size_t);
563u64 nfsd_inject_forget_clients(u64);
Jeff Laytona0926d12014-07-30 08:27:18 -0400564
Jeff Layton285abde2014-07-30 08:27:24 -0400565u64 nfsd_inject_print_locks(void);
566u64 nfsd_inject_forget_client_locks(struct sockaddr_storage *, size_t);
567u64 nfsd_inject_forget_locks(u64);
Jeff Layton016200c2014-07-30 08:27:21 -0400568
Jeff Layton285abde2014-07-30 08:27:24 -0400569u64 nfsd_inject_print_openowners(void);
570u64 nfsd_inject_forget_client_openowners(struct sockaddr_storage *, size_t);
571u64 nfsd_inject_forget_openowners(u64);
Jeff Layton82e05ef2014-07-30 08:27:22 -0400572
Jeff Layton285abde2014-07-30 08:27:24 -0400573u64 nfsd_inject_print_delegations(void);
574u64 nfsd_inject_forget_client_delegations(struct sockaddr_storage *, size_t);
575u64 nfsd_inject_forget_delegations(u64);
576u64 nfsd_inject_recall_client_delegations(struct sockaddr_storage *, size_t);
577u64 nfsd_inject_recall_delegations(u64);
Bryan Schumakerf3c75212012-11-27 09:35:10 -0500578#else /* CONFIG_NFSD_FAULT_INJECTION */
579static inline int nfsd_fault_inject_init(void) { return 0; }
580static inline void nfsd_fault_inject_cleanup(void) {}
581#endif /* CONFIG_NFSD_FAULT_INJECTION */
582
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583#endif /* NFSD4_STATE_H */