blob: 005c911b34ac4553a2c02da05b4e5d975b660710 [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 struct nfs4_client *cb_clp;
J. Bruce Fields58784532010-05-16 16:47:08 -040066 struct rpc_message cb_msg;
Julia Lawallc4cb8972015-11-21 22:57:39 +010067 const struct nfsd4_callback_ops *cb_ops;
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -050068 struct work_struct cb_work;
Kinglong Mee7ba6cad2015-06-24 16:33:37 +080069 int cb_seq_status;
Christoph Hellwigef2a1b32015-04-30 11:49:23 +020070 int cb_status;
Christoph Hellwigcba5f622015-04-30 11:49:24 +020071 bool cb_need_restart;
J. Bruce Fields227f98d92010-02-18 08:27:24 -080072};
73
Christoph Hellwig0162ac22014-09-24 12:19:19 +020074struct nfsd4_callback_ops {
75 void (*prepare)(struct nfsd4_callback *);
76 int (*done)(struct nfsd4_callback *, struct rpc_task *);
77 void (*release)(struct nfsd4_callback *);
78};
79
Jeff Layton14a571a2014-08-05 15:13:30 -040080/*
81 * A core object that represents a "common" stateid. These are generally
82 * embedded within the different (more specific) stateid objects and contain
83 * fields that are of general use to any stateid.
84 */
J. Bruce Fieldsd5477a82011-09-08 12:07:44 -040085struct nfs4_stid {
Jeff Layton9767feb2015-10-01 09:05:50 -040086 atomic_t sc_count;
J. Bruce Fieldsd5477a82011-09-08 12:07:44 -040087#define NFS4_OPEN_STID 1
88#define NFS4_LOCK_STID 2
89#define NFS4_DELEG_STID 4
J. Bruce Fieldsf7a4d872011-09-16 20:12:38 -040090/* For an open stateid kept around *only* to process close replays: */
91#define NFS4_CLOSED_STID 8
J. Bruce Fields3bd64a52013-04-09 17:02:51 -040092/* For a deleg stateid kept around only to process free_stateid's: */
93#define NFS4_REVOKED_DELEG_STID 16
Trond Myklebustb0fc29d2014-07-16 10:31:59 -040094#define NFS4_CLOSED_DELEG_STID 32
Christoph Hellwig9cf514c2014-05-05 13:11:59 +020095#define NFS4_LAYOUT_STID 64
Jeff Layton9767feb2015-10-01 09:05:50 -040096 unsigned char sc_type;
97 stateid_t sc_stateid;
98 spinlock_t sc_lock;
99 struct nfs4_client *sc_client;
100 struct nfs4_file *sc_file;
101 void (*sc_free)(struct nfs4_stid *);
J. Bruce Fieldsd5477a82011-09-08 12:07:44 -0400102};
103
Jeff Layton14a571a2014-08-05 15:13:30 -0400104/*
105 * Represents a delegation stateid. The nfs4_client holds references to these
106 * and they are put when it is being destroyed or when the delegation is
107 * returned by the client:
108 *
109 * o 1 reference as long as a delegation is still in force (taken when it's
110 * alloc'd, put when it's returned or revoked)
111 *
112 * o 1 reference as long as a recall rpc is in progress (taken when the lease
113 * is broken, put when the rpc exits)
114 *
115 * o 1 more ephemeral reference for each nfsd thread currently doing something
116 * with that delegation without holding the cl_lock
117 *
118 * If the server attempts to recall a delegation and the client doesn't do so
119 * before a timeout, the server may also revoke the delegation. In that case,
120 * the object will either be destroyed (v4.0) or moved to a per-client list of
121 * revoked delegations (v4.1+).
122 *
123 * This object is a superset of the nfs4_stid.
124 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125struct nfs4_delegation {
J. Bruce Fields996e0932011-10-17 11:14:48 -0400126 struct nfs4_stid dl_stid; /* must be first field */
NeilBrownea1da632005-06-23 22:04:17 -0700127 struct list_head dl_perfile;
128 struct list_head dl_perclnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 struct list_head dl_recall_lru; /* delegation recalled */
Sachin Bhamare8287f002015-04-27 14:50:14 +0200130 struct nfs4_clnt_odstate *dl_clnt_odstate;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131 u32 dl_type;
132 time_t dl_time;
J. Bruce Fieldsb53d40c2009-05-01 19:50:00 -0400133/* For recall: */
J. Bruce Fields3aea09d2009-05-01 20:11:12 -0400134 int dl_retries;
J. Bruce Fields227f98d92010-02-18 08:27:24 -0800135 struct nfsd4_callback dl_recall;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136};
137
Jeff Layton34549ab2014-10-01 08:05:22 -0400138#define cb_to_delegation(cb) \
139 container_of(cb, struct nfs4_delegation, dl_recall)
140
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141/* client delegation callback info */
J. Bruce Fieldsc237dc02009-04-29 19:09:19 -0400142struct nfs4_cb_conn {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 /* SETCLIENTID info */
Jeff Laytonaa9a4ec2009-08-14 12:57:57 -0400144 struct sockaddr_storage cb_addr;
Takuma Umeya6f3d7722010-12-15 14:09:01 +0900145 struct sockaddr_storage cb_saddr;
Jeff Laytonaa9a4ec2009-08-14 12:57:57 -0400146 size_t cb_addrlen;
J. Bruce Fields8b5ce5c2010-10-19 17:31:50 -0400147 u32 cb_prog; /* used only in 4.0 case;
148 per-session otherwise */
Andy Adamsonab52ae62009-06-16 04:20:53 +0300149 u32 cb_ident; /* minorversion 0 only */
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500150 struct svc_xprt *cb_xprt; /* minorversion 1 only */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151};
152
J. Bruce Fieldsf459e452011-09-09 09:06:12 -0400153static inline struct nfs4_delegation *delegstateid(struct nfs4_stid *s)
154{
155 return container_of(s, struct nfs4_delegation, dl_stid);
156}
157
Andy Adamsona6496372009-08-28 08:45:01 -0400158/* Maximum number of slots per session. 160 is useful for long haul TCP */
159#define NFSD_MAX_SLOTS_PER_SESSION 160
Andy Adamsonec6b5d72009-04-03 08:28:28 +0300160/* Maximum number of operations per session compound */
161#define NFSD_MAX_OPS_PER_COMPOUND 16
Andy Adamson557ce262009-08-28 08:45:04 -0400162/* Maximum session per slot cache size */
J. Bruce Fields24906f32014-03-12 15:17:18 -0400163#define NFSD_SLOT_CACHE_SIZE 2048
Andy Adamsona6496372009-08-28 08:45:01 -0400164/* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
165#define NFSD_CACHE_SIZE_SLOTS_PER_SESSION 32
166#define NFSD_MAX_MEM_PER_SESSION \
167 (NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
Andy Adamson074fe892009-04-03 08:28:15 +0300168
Andy Adamson7116ed62009-04-03 08:27:43 +0300169struct nfsd4_slot {
Andy Adamson557ce262009-08-28 08:45:04 -0400170 u32 sl_seqid;
171 __be32 sl_status;
172 u32 sl_datalen;
J. Bruce Fields73e79482012-02-13 16:39:00 -0500173 u16 sl_opcnt;
174#define NFSD4_SLOT_INUSE (1 << 0)
175#define NFSD4_SLOT_CACHETHIS (1 << 1)
J. Bruce Fieldsbf5c43c2012-02-13 16:56:19 -0500176#define NFSD4_SLOT_INITIALIZED (1 << 2)
J. Bruce Fields73e79482012-02-13 16:39:00 -0500177 u8 sl_flags;
Andy Adamson557ce262009-08-28 08:45:04 -0400178 char sl_data[];
Andy Adamson7116ed62009-04-03 08:27:43 +0300179};
180
Alexandros Batsakis6c18ba92009-06-16 04:19:13 +0300181struct nfsd4_channel_attrs {
182 u32 headerpadsz;
183 u32 maxreq_sz;
184 u32 maxresp_sz;
185 u32 maxresp_cached;
186 u32 maxops;
187 u32 maxreqs;
188 u32 nr_rdma_attrs;
189 u32 rdma_attrs;
190};
191
J. Bruce Fieldsacb28872012-03-27 14:50:26 -0400192struct nfsd4_cb_sec {
J. Bruce Fields12fc3e92012-11-05 16:01:48 -0500193 u32 flavor; /* (u32)(-1) used to mean "no valid flavor" */
Eric W. Biederman03bc6d12013-02-02 06:24:49 -0800194 kuid_t uid;
195 kgid_t gid;
J. Bruce Fieldsacb28872012-03-27 14:50:26 -0400196};
197
Andy Adamson49557cc2009-07-23 19:02:16 -0400198struct nfsd4_create_session {
199 clientid_t clientid;
200 struct nfs4_sessionid sessionid;
201 u32 seqid;
202 u32 flags;
203 struct nfsd4_channel_attrs fore_channel;
204 struct nfsd4_channel_attrs back_channel;
205 u32 callback_prog;
J. Bruce Fieldsacb28872012-03-27 14:50:26 -0400206 struct nfsd4_cb_sec cb_sec;
Andy Adamson49557cc2009-07-23 19:02:16 -0400207};
208
J. Bruce Fieldscb73a9f2012-11-01 18:09:48 -0400209struct nfsd4_backchannel_ctl {
210 u32 bc_cb_program;
211 struct nfsd4_cb_sec bc_cb_sec;
212};
213
J. Bruce Fields1d1bc8f2010-10-04 23:12:59 -0400214struct nfsd4_bind_conn_to_session {
215 struct nfs4_sessionid sessionid;
216 u32 dir;
217};
218
Andy Adamson49557cc2009-07-23 19:02:16 -0400219/* The single slot clientid cache structure */
220struct nfsd4_clid_slot {
221 u32 sl_seqid;
222 __be32 sl_status;
223 struct nfsd4_create_session sl_cr_ses;
224};
225
J. Bruce Fieldsc7662512010-06-06 18:12:14 -0400226struct nfsd4_conn {
227 struct list_head cn_persession;
228 struct svc_xprt *cn_xprt;
J. Bruce Fields19cf5c02010-06-06 18:37:16 -0400229 struct svc_xpt_user cn_xpt_user;
230 struct nfsd4_session *cn_session;
J. Bruce Fieldsc7662512010-06-06 18:12:14 -0400231/* CDFC4_FORE, CDFC4_BACK: */
232 unsigned char cn_flags;
233};
234
Jeff Layton14a571a2014-08-05 15:13:30 -0400235/*
236 * Representation of a v4.1+ session. These are refcounted in a similar fashion
237 * to the nfs4_client. References are only taken when the server is actively
238 * working on the object (primarily during the processing of compounds).
239 */
Andy Adamson7116ed62009-04-03 08:27:43 +0300240struct nfsd4_session {
J. Bruce Fields66b2b9b2013-03-19 12:05:39 -0400241 atomic_t se_ref;
Andy Adamson7116ed62009-04-03 08:27:43 +0300242 struct list_head se_hash; /* hash by sessionid */
243 struct list_head se_perclnt;
J. Bruce Fields66b2b9b2013-03-19 12:05:39 -0400244/* See SESSION4_PERSIST, etc. for standard flags; this is internal-only: */
245#define NFS4_SESSION_DEAD 0x010
Andy Adamson7116ed62009-04-03 08:27:43 +0300246 u32 se_flags;
Benny Halevy07cd4902010-05-12 00:13:41 +0300247 struct nfs4_client *se_client;
Andy Adamson7116ed62009-04-03 08:27:43 +0300248 struct nfs4_sessionid se_sessionid;
Alexandros Batsakis6c18ba92009-06-16 04:19:13 +0300249 struct nfsd4_channel_attrs se_fchannel;
250 struct nfsd4_channel_attrs se_bchannel;
J. Bruce Fieldsacb28872012-03-27 14:50:26 -0400251 struct nfsd4_cb_sec se_cb_sec;
J. Bruce Fieldsc7662512010-06-06 18:12:14 -0400252 struct list_head se_conns;
J. Bruce Fields8b5ce5c2010-10-19 17:31:50 -0400253 u32 se_cb_prog;
J. Bruce Fieldsac7c46f2010-06-14 19:01:57 -0400254 u32 se_cb_seq_nr;
Andy Adamson557ce262009-08-28 08:45:04 -0400255 struct nfsd4_slot *se_slots[]; /* forward channel slots */
Andy Adamson7116ed62009-04-03 08:27:43 +0300256};
257
Marc Eshel5282fd72009-04-03 08:27:52 +0300258/* formatted contents of nfs4_sessionid */
259struct nfsd4_sessionid {
260 clientid_t clientid;
261 u32 sequence;
262 u32 reserved;
263};
264
NeilBrowna55370a2005-06-23 22:03:52 -0700265#define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */
266
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267/*
268 * struct nfs4_client - one per client. Clientids live here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 *
Jeff Layton14a571a2014-08-05 15:13:30 -0400270 * The initial object created by an NFS client using SETCLIENTID (for NFSv4.0)
271 * or EXCHANGE_ID (for NFSv4.1+). These objects are refcounted and timestamped.
272 * Each nfsd_net_ns object contains a set of these and they are tracked via
273 * short and long form clientid. They are hashed and searched for under the
274 * per-nfsd_net client_lock spinlock.
275 *
276 * References to it are only held during the processing of compounds, and in
277 * certain other operations. In their "resting state" they have a refcount of
278 * 0. If they are not renewed within a lease period, they become eligible for
279 * destruction by the laundromat.
280 *
281 * These objects can also be destroyed prematurely by the fault injection code,
282 * or if the client sends certain forms of SETCLIENTID or EXCHANGE_ID updates.
283 * Care is taken *not* to do this however when the objects have an elevated
284 * refcount.
285 *
286 * o Each nfs4_client is hashed by clientid
287 *
288 * o Each nfs4_clients is also hashed by name (the opaque quantity initially
289 * sent by the client to identify itself).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290 *
Jeff Layton14a571a2014-08-05 15:13:30 -0400291 * o cl_perclient list is used to ensure no dangling stateowner references
292 * when we expire the nfs4_client
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293 */
294struct nfs4_client {
295 struct list_head cl_idhash; /* hash by cl_clientid.id */
Jeff Laytonac55fdc2012-11-12 15:00:56 -0500296 struct rb_node cl_namenode; /* link into by-name trees */
Trond Myklebustd4f04892014-07-29 21:34:36 -0400297 struct list_head *cl_ownerstr_hashtbl;
NeilBrownea1da632005-06-23 22:04:17 -0700298 struct list_head cl_openowners;
J. Bruce Fields38c2f4b2011-09-23 17:01:19 -0400299 struct idr cl_stateids; /* stateid lookup */
NeilBrownea1da632005-06-23 22:04:17 -0700300 struct list_head cl_delegations;
J. Bruce Fields3bd64a52013-04-09 17:02:51 -0400301 struct list_head cl_revoked; /* unacknowledged, revoked 4.1 state */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 struct list_head cl_lru; /* tail queue */
Christoph Hellwig9cf514c2014-05-05 13:11:59 +0200303#ifdef CONFIG_NFSD_PNFS
304 struct list_head cl_lo_states; /* outstanding layout states */
305#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 struct xdr_netobj cl_name; /* id generated by client */
307 nfs4_verifier cl_verifier; /* generated by client */
308 time_t cl_time; /* time of last lease renewal */
Jeff Layton363168b2009-08-14 12:57:56 -0400309 struct sockaddr_storage cl_addr; /* client ipaddress */
J. Bruce Fields57266a62013-04-13 14:27:29 -0400310 bool cl_mach_cred; /* SP4_MACH_CRED in force */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 struct svc_cred cl_cred; /* setclientid principal */
312 clientid_t cl_clientid; /* generated by server */
313 nfs4_verifier cl_confirm; /* generated by server */
J. Bruce Fields8323c3b2010-10-19 19:36:51 -0400314 u32 cl_minorversion;
Marc Eshel9fb87072009-04-03 08:27:46 +0300315
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500316 /* for v4.0 and v4.1 callbacks: */
317 struct nfs4_cb_conn cl_cb_conn;
Jeff Laytona52d7262012-03-21 09:52:02 -0400318#define NFSD4_CLIENT_CB_UPDATE (0)
319#define NFSD4_CLIENT_CB_KILL (1)
320#define NFSD4_CLIENT_STABLE (2) /* client on stable storage */
321#define NFSD4_CLIENT_RECLAIM_COMPLETE (3) /* reclaim_complete done */
Jeff Laytonac55fdc2012-11-12 15:00:56 -0500322#define NFSD4_CLIENT_CONFIRMED (4) /* client is confirmed */
Jeff Laytond682e752014-09-12 16:40:21 -0400323#define NFSD4_CLIENT_UPCALL_LOCK (5) /* upcall serialization */
Jeff Laytona52d7262012-03-21 09:52:02 -0400324#define NFSD4_CLIENT_CB_FLAG_MASK (1 << NFSD4_CLIENT_CB_UPDATE | \
325 1 << NFSD4_CLIENT_CB_KILL)
326 unsigned long cl_flags;
J. Bruce Fieldsc6bb3ca2012-11-01 16:31:02 -0400327 struct rpc_cred *cl_cb_cred;
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500328 struct rpc_clnt *cl_cb_client;
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400329 u32 cl_cb_ident;
J. Bruce Fields77a35692010-04-30 18:51:44 -0400330#define NFSD4_CB_UP 0
331#define NFSD4_CB_UNKNOWN 1
332#define NFSD4_CB_DOWN 2
Benny Halevy54237322011-10-19 19:12:58 -0700333#define NFSD4_CB_FAULT 3
J. Bruce Fields77a35692010-04-30 18:51:44 -0400334 int cl_cb_state;
J. Bruce Fieldscee277d2010-05-26 17:52:14 -0400335 struct nfsd4_callback cl_cb_null;
J. Bruce Fieldsedd76782010-06-14 22:26:31 -0400336 struct nfsd4_session *cl_cb_session;
J. Bruce Fields2bf23872010-03-08 12:37:27 -0500337
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400338 /* for all client information that callback code might need: */
339 spinlock_t cl_lock;
340
Marc Eshel9fb87072009-04-03 08:27:46 +0300341 /* for nfs41 */
342 struct list_head cl_sessions;
Andy Adamson49557cc2009-07-23 19:02:16 -0400343 struct nfsd4_clid_slot cl_cs_slot; /* create_session slot */
Andy Adamson0733d212009-04-03 08:28:01 +0300344 u32 cl_exchange_flags;
Benny Halevy46583e22010-05-12 00:13:29 +0300345 /* number of rpc's in progress over an associated session: */
346 atomic_t cl_refcount;
Andrew Elbleed941642016-06-15 12:52:09 -0400347 struct nfs4_op_map cl_spo_must_allow;
Andy Adamson38524ab2009-09-10 12:25:59 +0300348
349 /* for nfs41 callbacks */
Ricardo Labiaga199ff352009-09-10 12:26:25 +0300350 /* We currently support a single back channel with a single slot */
351 unsigned long cl_cb_slot_busy;
Ricardo Labiaga199ff352009-09-10 12:26:25 +0300352 struct rpc_wait_queue cl_cb_waitq; /* backchannel callers may */
353 /* wait here for slots */
Stanislav Kinsburskyc212cec2012-11-14 18:21:10 +0300354 struct net *net;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355};
356
357/* struct nfs4_client_reset
358 * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
359 * upon lease reset, or from upcall to state_daemon (to read in state
360 * from non-volitile storage) upon reboot.
361 */
362struct nfs4_client_reclaim {
363 struct list_head cr_strhash; /* hash by cr_name */
Jeff Layton0ce0c2b2012-11-12 15:00:55 -0500364 struct nfs4_client *cr_clp; /* pointer to associated clp */
NeilBrowna55370a2005-06-23 22:03:52 -0700365 char cr_recdir[HEXDIR_LEN]; /* recover dir */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366};
367
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368/* A reasonable value for REPLAY_ISIZE was estimated as follows:
369 * The OPEN response, typically the largest, requires
370 * 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) +
371 * 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
372 * 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
373 */
374
375#define NFSD4_REPLAY_ISIZE 112
376
377/*
378 * Replay buffer, where the result of the last seqid-mutating operation
379 * is cached.
380 */
381struct nfs4_replay {
Al Virob37ad282006-10-19 23:28:59 -0700382 __be32 rp_status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 unsigned int rp_buflen;
384 char *rp_buf;
J. Bruce Fieldsa4773c02009-02-02 17:23:10 -0500385 struct knfsd_fh rp_openfh;
Jeff Layton58fb12e2014-07-29 21:34:27 -0400386 struct mutex rp_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 char rp_ibuf[NFSD4_REPLAY_ISIZE];
388};
389
Jeff Layton6b180f02014-07-29 21:34:26 -0400390struct nfs4_stateowner;
391
392struct nfs4_stateowner_operations {
Jeff Layton8f4b54c2014-07-29 21:34:29 -0400393 void (*so_unhash)(struct nfs4_stateowner *);
Jeff Layton6b180f02014-07-29 21:34:26 -0400394 void (*so_free)(struct nfs4_stateowner *);
395};
396
Jeff Layton14a571a2014-08-05 15:13:30 -0400397/*
398 * A core object that represents either an open or lock owner. The object and
399 * lock owner objects have one of these embedded within them. Refcounts and
400 * other fields common to both owner types are contained within these
401 * structures.
402 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403struct nfs4_stateowner {
Jeff Layton6b180f02014-07-29 21:34:26 -0400404 struct list_head so_strhash;
405 struct list_head so_stateids;
406 struct nfs4_client *so_client;
407 const struct nfs4_stateowner_operations *so_ops;
J. Bruce Fields83e452f2014-07-31 16:10:08 -0400408 /* after increment in nfsd4_bump_seqid, represents the next
NeilBrown7fb64ce2005-07-07 17:59:20 -0700409 * sequence id expected from the client: */
Jeff Layton6b180f02014-07-29 21:34:26 -0400410 atomic_t so_count;
411 u32 so_seqid;
412 struct xdr_netobj so_owner; /* open owner name */
413 struct nfs4_replay so_replay;
414 bool so_is_open_owner;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415};
416
Jeff Layton14a571a2014-08-05 15:13:30 -0400417/*
418 * When a file is opened, the client provides an open state owner opaque string
419 * that indicates the "owner" of that open. These objects are refcounted.
420 * References to it are held by each open state associated with it. This object
421 * is a superset of the nfs4_stateowner struct.
422 */
J. Bruce Fieldsfe0750e2011-07-30 23:33:59 -0400423struct nfs4_openowner {
424 struct nfs4_stateowner oo_owner; /* must be first field */
425 struct list_head oo_perclient;
J. Bruce Fieldsb31b30e2011-09-28 11:47:20 -0400426 /*
427 * We keep around openowners a little while after last close,
428 * which saves clients from having to confirm, and allows us to
429 * handle close replays if they come soon enough. The close_lru
430 * is a list of such openowners, to be reaped by the laundromat
431 * thread eventually if they remain unused:
432 */
433 struct list_head oo_close_lru;
J. Bruce Fields38c387b2011-09-16 17:42:48 -0400434 struct nfs4_ol_stateid *oo_last_closed_stid;
J. Bruce Fieldsfe0750e2011-07-30 23:33:59 -0400435 time_t oo_time; /* time of placement on so_close_lru */
J. Bruce Fieldsdad1c062011-09-12 12:24:13 -0400436#define NFS4_OO_CONFIRMED 1
437 unsigned char oo_flags;
J. Bruce Fieldsfe0750e2011-07-30 23:33:59 -0400438};
439
Jeff Layton14a571a2014-08-05 15:13:30 -0400440/*
441 * Represents a generic "lockowner". Similar to an openowner. References to it
442 * are held by the lock stateids that are created on its behalf. This object is
Jeff Layton76d348f2016-09-16 16:28:24 -0400443 * a superset of the nfs4_stateowner struct.
Jeff Layton14a571a2014-08-05 15:13:30 -0400444 */
J. Bruce Fieldsfe0750e2011-07-30 23:33:59 -0400445struct nfs4_lockowner {
Jeff Layton76d348f2016-09-16 16:28:24 -0400446 struct nfs4_stateowner lo_owner; /* must be first element */
447 struct list_head lo_blocked; /* blocked file_locks */
J. Bruce Fieldsfe0750e2011-07-30 23:33:59 -0400448};
449
450static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so)
451{
452 return container_of(so, struct nfs4_openowner, oo_owner);
453}
454
455static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so)
456{
457 return container_of(so, struct nfs4_lockowner, lo_owner);
458}
459
Jeff Layton14a571a2014-08-05 15:13:30 -0400460/*
Sachin Bhamare8287f002015-04-27 14:50:14 +0200461 * Per-client state indicating no. of opens and outstanding delegations
462 * on a file from a particular client.'od' stands for 'open & delegation'
463 */
464struct nfs4_clnt_odstate {
465 struct nfs4_client *co_client;
466 struct nfs4_file *co_file;
467 struct list_head co_perfile;
468 atomic_t co_odcount;
469};
470
471/*
Jeff Layton14a571a2014-08-05 15:13:30 -0400472 * nfs4_file: a file opened by some number of (open) nfs4_stateowners.
473 *
Jeff Laytonccc63982014-10-16 08:49:37 -0400474 * These objects are global. nfsd keeps one instance of a nfs4_file per
475 * filehandle (though it may keep multiple file descriptors for each). Each
476 * inode can have multiple filehandles associated with it, so there is
477 * (potentially) a many to one relationship between this struct and struct
478 * inode.
479 *
480 * These are hashed by filehandle in the file_hashtbl, which is protected by
481 * the global state_lock spinlock.
Jeff Layton14a571a2014-08-05 15:13:30 -0400482 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483struct nfs4_file {
J. Bruce Fields8b671b82009-02-22 14:51:34 -0800484 atomic_t fi_ref;
Trond Myklebust1d31a252014-07-10 14:07:25 -0400485 spinlock_t fi_lock;
Jeff Laytonccc63982014-10-16 08:49:37 -0400486 struct hlist_node fi_hash; /* hash on fi_fhandle */
NeilBrown8beefa22005-06-23 22:03:08 -0700487 struct list_head fi_stateids;
Jeff Layton5b095e92014-10-23 08:01:02 -0400488 union {
489 struct list_head fi_delegations;
490 struct rcu_head fi_rcu;
491 };
Sachin Bhamare8287f002015-04-27 14:50:14 +0200492 struct list_head fi_clnt_odstate;
J. Bruce Fieldsf9d75622010-07-08 11:02:09 -0400493 /* One each for O_RDONLY, O_WRONLY, O_RDWR: */
494 struct file * fi_fds[3];
J. Bruce Fieldsf9d75622010-07-08 11:02:09 -0400495 /*
J. Bruce Fields6409a5a2011-09-28 11:37:56 -0400496 * Each open or lock stateid contributes 0-4 to the counts
497 * below depending on which bits are set in st_access_bitmap:
498 * 1 to fi_access[O_RDONLY] if NFS4_SHARE_ACCES_READ is set
499 * + 1 to fi_access[O_WRONLY] if NFS4_SHARE_ACCESS_WRITE is set
500 * + 1 to both of the above if NFS4_SHARE_ACCESS_BOTH is set.
J. Bruce Fieldsf9d75622010-07-08 11:02:09 -0400501 */
J. Bruce Fields9ae78bc2011-03-17 12:52:33 -0400502 atomic_t fi_access[2];
Jeff Laytonbaeb4ff2014-07-10 14:07:34 -0400503 u32 fi_share_deny;
J. Bruce Fieldsacfdf5c2011-01-31 19:20:39 -0500504 struct file *fi_deleg_file;
Jeff Layton67db1032014-12-13 09:11:40 -0500505 int fi_delegees;
Trond Myklebuste2cf80d2014-07-23 16:17:38 -0400506 struct knfsd_fh fi_fhandle;
Meelap Shah47f99402007-07-17 04:04:40 -0700507 bool fi_had_conflict;
Christoph Hellwig9cf514c2014-05-05 13:11:59 +0200508#ifdef CONFIG_NFSD_PNFS
509 struct list_head fi_lo_states;
Christoph Hellwigc5c707f2014-09-23 12:38:48 +0200510 atomic_t fi_lo_recalls;
Christoph Hellwig9cf514c2014-05-05 13:11:59 +0200511#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512};
513
Jeff Layton14a571a2014-08-05 15:13:30 -0400514/*
515 * A generic struct representing either a open or lock stateid. The nfs4_client
516 * holds a reference to each of these objects, and they in turn hold a
517 * reference to their respective stateowners. The client's reference is
518 * released in response to a close or unlock (depending on whether it's an open
519 * or lock stateid) or when the client is being destroyed.
520 *
521 * In the case of v4.0 open stateids, these objects are preserved for a little
522 * while after close in order to handle CLOSE replays. Those are eventually
523 * reclaimed via a LRU scheme by the laundromat.
524 *
525 * This object is a superset of the nfs4_stid. "ol" stands for "Open or Lock".
526 * Better suggestions welcome.
527 */
J. Bruce Fieldsdcef0412011-09-07 16:06:42 -0400528struct nfs4_ol_stateid {
Jeff Layton35a92fe2015-09-17 07:47:08 -0400529 struct nfs4_stid st_stid;
530 struct list_head st_perfile;
531 struct list_head st_perstateowner;
532 struct list_head st_locks;
533 struct nfs4_stateowner *st_stateowner;
534 struct nfs4_clnt_odstate *st_clnt_odstate;
535 unsigned char st_access_bmap;
536 unsigned char st_deny_bmap;
537 struct nfs4_ol_stateid *st_openstp;
Oleg Drokinfeb9dad2016-06-14 23:28:04 -0400538 struct mutex st_mutex;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539};
540
J. Bruce Fieldsdcef0412011-09-07 16:06:42 -0400541static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s)
542{
543 return container_of(s, struct nfs4_ol_stateid, st_stid);
544}
545
Christoph Hellwig9cf514c2014-05-05 13:11:59 +0200546struct nfs4_layout_stateid {
547 struct nfs4_stid ls_stid;
548 struct list_head ls_perclnt;
549 struct list_head ls_perfile;
550 spinlock_t ls_lock;
551 struct list_head ls_layouts;
552 u32 ls_layout_type;
Christoph Hellwigc5c707f2014-09-23 12:38:48 +0200553 struct file *ls_file;
554 struct nfsd4_callback ls_recall;
555 stateid_t ls_recall_sid;
556 bool ls_recalled;
Jeff Laytoncc8a5532015-09-17 07:58:24 -0400557 struct mutex ls_mutex;
Christoph Hellwig9cf514c2014-05-05 13:11:59 +0200558};
559
560static inline struct nfs4_layout_stateid *layoutstateid(struct nfs4_stid *s)
561{
562 return container_of(s, struct nfs4_layout_stateid, ls_stid);
563}
564
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565/* flags for preprocess_seqid_op() */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566#define RD_STATE 0x00000010
567#define WR_STATE 0x00000020
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568
Christoph Hellwig326129d2014-09-24 12:19:17 +0200569enum nfsd4_cb_op {
570 NFSPROC4_CLNT_CB_NULL = 0,
571 NFSPROC4_CLNT_CB_RECALL,
Christoph Hellwigc5c707f2014-09-23 12:38:48 +0200572 NFSPROC4_CLNT_CB_LAYOUT,
Christoph Hellwig326129d2014-09-24 12:19:17 +0200573 NFSPROC4_CLNT_CB_SEQUENCE,
Jeff Laytona188620e2016-09-16 16:28:23 -0400574 NFSPROC4_CLNT_CB_NOTIFY_LOCK,
Christoph Hellwig326129d2014-09-24 12:19:17 +0200575};
576
Jeff Layton14b7f4a2016-05-05 06:53:47 -0400577/* Returns true iff a is later than b: */
578static inline bool nfsd4_stateid_generation_after(stateid_t *a, stateid_t *b)
579{
580 return (s32)(a->si_generation - b->si_generation) > 0;
581}
Christoph Hellwig326129d2014-09-24 12:19:17 +0200582
Jeff Layton76d348f2016-09-16 16:28:24 -0400583/*
584 * When a client tries to get a lock on a file, we set one of these objects
585 * on the blocking lock. When the lock becomes free, we can then issue a
586 * CB_NOTIFY_LOCK to the server.
587 */
Jeff Laytona188620e2016-09-16 16:28:23 -0400588struct nfsd4_blocked_lock {
Jeff Layton76d348f2016-09-16 16:28:24 -0400589 struct list_head nbl_list;
Jeff Layton7919d0a2016-09-16 16:28:25 -0400590 struct list_head nbl_lru;
591 unsigned long nbl_time;
Jeff Laytona188620e2016-09-16 16:28:23 -0400592 struct file_lock nbl_lock;
593 struct knfsd_fh nbl_fh;
594 struct nfsd4_callback nbl_cb;
595};
596
Benny Halevydd453df2009-04-03 08:28:41 +0300597struct nfsd4_compound_state;
Stanislav Kinsbursky2c142ba2012-07-25 16:57:45 +0400598struct nfsd_net;
Benny Halevydd453df2009-04-03 08:28:41 +0300599
Christoph Hellwigaf90f702015-06-18 16:45:00 +0200600extern __be32 nfs4_preprocess_stateid_op(struct svc_rqst *rqstp,
Anna Schumakeraa0d6ae2015-12-03 12:59:51 +0100601 struct nfsd4_compound_state *cstate, struct svc_fh *fhp,
602 stateid_t *stateid, int flags, struct file **filp, bool *tmp_file);
Christoph Hellwigcd61c522014-08-14 08:44:57 +0200603__be32 nfsd4_lookup_stateid(struct nfsd4_compound_state *cstate,
604 stateid_t *stateid, unsigned char typemask,
605 struct nfs4_stid **s, struct nfsd_net *nn);
Kinglong Meed19fb702017-01-18 19:04:42 +0800606struct nfs4_stid *nfs4_alloc_stid(struct nfs4_client *cl, struct kmem_cache *slab,
607 void (*sc_free)(struct nfs4_stid *));
Christoph Hellwigcd61c522014-08-14 08:44:57 +0200608void nfs4_unhash_stid(struct nfs4_stid *s);
Trond Myklebust60116952014-07-29 21:34:06 -0400609void nfs4_put_stid(struct nfs4_stid *s);
Jeff Layton9767feb2015-10-01 09:05:50 -0400610void nfs4_inc_and_copy_stateid(stateid_t *dst, struct nfs4_stid *stid);
Stanislav Kinsbursky52e19c02012-11-14 18:21:16 +0300611void nfs4_remove_reclaim_record(struct nfs4_client_reclaim *, struct nfsd_net *);
612extern void nfs4_release_reclaim(struct nfsd_net *);
613extern struct nfs4_client_reclaim *nfsd4_find_reclaim_client(const char *recdir,
614 struct nfsd_net *nn);
Trond Myklebust0fe492d2014-06-30 11:48:47 -0400615extern __be32 nfs4_check_open_reclaim(clientid_t *clid,
616 struct nfsd4_compound_state *cstate, struct nfsd_net *nn);
J. Bruce Fields80fc0152009-09-15 18:07:35 -0400617extern int set_callback_cred(void);
Kinglong Meef7d1ddb2017-02-05 09:57:07 +0800618extern void cleanup_callback_cred(void);
J. Bruce Fields5a3c9d72010-10-19 17:56:52 -0400619extern void nfsd4_probe_callback(struct nfs4_client *clp);
J. Bruce Fields84f5f7c2010-12-09 15:52:19 -0500620extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
J. Bruce Fields5a3c9d72010-10-19 17:56:52 -0400621extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
Christoph Hellwigf0b5de12014-09-24 12:19:18 +0200622extern void nfsd4_init_cb(struct nfsd4_callback *cb, struct nfs4_client *clp,
Julia Lawallc4cb8972015-11-21 22:57:39 +0100623 const struct nfsd4_callback_ops *ops, enum nfsd4_cb_op op);
Christoph Hellwigf0b5de12014-09-24 12:19:18 +0200624extern void nfsd4_run_cb(struct nfsd4_callback *cb);
J. Bruce Fieldsb5a1a812010-03-03 14:52:55 -0500625extern int nfsd4_create_callback_queue(void);
626extern void nfsd4_destroy_callback_queue(void);
J. Bruce Fields6ff8da02010-06-04 20:04:45 -0400627extern void nfsd4_shutdown_callback(struct nfs4_client *);
Jeff Layton02e12152014-07-16 10:31:57 -0400628extern void nfsd4_prepare_cb_recall(struct nfs4_delegation *dp);
Stanislav Kinsbursky52e19c02012-11-14 18:21:16 +0300629extern struct nfs4_client_reclaim *nfs4_client_to_reclaim(const char *name,
630 struct nfsd_net *nn);
631extern bool nfs4_has_reclaimed_state(const char *name, struct nfsd_net *nn);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632
Christoph Hellwige6ba76e2014-08-14 08:50:16 +0200633struct nfs4_file *find_file(struct knfsd_fh *fh);
634void put_nfs4_file(struct nfs4_file *fi);
635static inline void get_nfs4_file(struct nfs4_file *fi)
636{
637 atomic_inc(&fi->fi_ref);
638}
Christoph Hellwig4d227fc2014-08-17 07:40:00 -0500639struct file *find_any_file(struct nfs4_file *f);
Christoph Hellwige6ba76e2014-08-14 08:50:16 +0200640
Jeff Layton7f5ef2e2014-09-12 16:40:21 -0400641/* grace period management */
642void nfsd4_end_grace(struct nfsd_net *nn);
643
Jeff Layton2a4317c2012-03-21 16:42:43 -0400644/* nfs4recover operations */
645extern int nfsd4_client_tracking_init(struct net *net);
646extern void nfsd4_client_tracking_exit(struct net *net);
647extern void nfsd4_client_record_create(struct nfs4_client *clp);
648extern void nfsd4_client_record_remove(struct nfs4_client *clp);
649extern int nfsd4_client_record_check(struct nfs4_client *clp);
Jeff Layton919b8042014-09-12 16:40:20 -0400650extern void nfsd4_record_grace_done(struct nfsd_net *nn);
Bryan Schumakerf3c75212012-11-27 09:35:10 -0500651
652/* nfs fault injection functions */
653#ifdef CONFIG_NFSD_FAULT_INJECTION
654int nfsd_fault_inject_init(void);
655void nfsd_fault_inject_cleanup(void);
Bryan Schumaker8ce54e02012-11-29 11:40:43 -0500656
Jeff Layton285abde2014-07-30 08:27:24 -0400657u64 nfsd_inject_print_clients(void);
658u64 nfsd_inject_forget_client(struct sockaddr_storage *, size_t);
659u64 nfsd_inject_forget_clients(u64);
Jeff Laytona0926d12014-07-30 08:27:18 -0400660
Jeff Layton285abde2014-07-30 08:27:24 -0400661u64 nfsd_inject_print_locks(void);
662u64 nfsd_inject_forget_client_locks(struct sockaddr_storage *, size_t);
663u64 nfsd_inject_forget_locks(u64);
Jeff Layton016200c2014-07-30 08:27:21 -0400664
Jeff Layton285abde2014-07-30 08:27:24 -0400665u64 nfsd_inject_print_openowners(void);
666u64 nfsd_inject_forget_client_openowners(struct sockaddr_storage *, size_t);
667u64 nfsd_inject_forget_openowners(u64);
Jeff Layton82e05ef2014-07-30 08:27:22 -0400668
Jeff Layton285abde2014-07-30 08:27:24 -0400669u64 nfsd_inject_print_delegations(void);
670u64 nfsd_inject_forget_client_delegations(struct sockaddr_storage *, size_t);
671u64 nfsd_inject_forget_delegations(u64);
672u64 nfsd_inject_recall_client_delegations(struct sockaddr_storage *, size_t);
673u64 nfsd_inject_recall_delegations(u64);
Bryan Schumakerf3c75212012-11-27 09:35:10 -0500674#else /* CONFIG_NFSD_FAULT_INJECTION */
675static inline int nfsd_fault_inject_init(void) { return 0; }
676static inline void nfsd_fault_inject_cleanup(void) {}
677#endif /* CONFIG_NFSD_FAULT_INJECTION */
678
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679#endif /* NFSD4_STATE_H */