Merge branch 'x86-urgent-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[linux-2.6-block.git] / fs / nfsd / state.h
CommitLineData
1da177e4 1/*
1da177e4
LT
2 * 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
38c2f4b1 38#include <linux/idr.h>
19cf5c02 39#include <linux/sunrpc/svc_xprt.h>
1557aca7 40#include "nfsfh.h"
1da177e4 41
1da177e4
LT
42typedef struct {
43 u32 cl_boot;
44 u32 cl_id;
45} clientid_t;
46
47typedef struct {
d3b313a4
BF
48 clientid_t so_clid;
49 u32 so_id;
1da177e4
LT
50} stateid_opaque_t;
51
52typedef struct {
53 u32 si_generation;
54 stateid_opaque_t si_opaque;
55} stateid_t;
1da177e4 56
8c10cbdb
BH
57#define STATEID_FMT "(%08x/%08x/%08x/%08x)"
58#define STATEID_VAL(s) \
d3b313a4
BF
59 (s)->si_opaque.so_clid.cl_boot, \
60 (s)->si_opaque.so_clid.cl_id, \
61 (s)->si_opaque.so_id, \
8c10cbdb
BH
62 (s)->si_generation
63
227f98d9 64struct nfsd4_callback {
fb003923
BF
65 struct nfs4_client *cb_clp;
66 u32 cb_minorversion;
5878453d 67 struct rpc_message cb_msg;
c4cb8974 68 const struct nfsd4_callback_ops *cb_ops;
b5a1a81e 69 struct work_struct cb_work;
7ba6cad6 70 int cb_seq_status;
ef2a1b3e 71 int cb_status;
cba5f62b 72 bool cb_need_restart;
227f98d9
BF
73};
74
0162ac2b
CH
75struct nfsd4_callback_ops {
76 void (*prepare)(struct nfsd4_callback *);
77 int (*done)(struct nfsd4_callback *, struct rpc_task *);
78 void (*release)(struct nfsd4_callback *);
79};
80
14a571a8
JL
81/*
82 * A core object that represents a "common" stateid. These are generally
83 * embedded within the different (more specific) stateid objects and contain
84 * fields that are of general use to any stateid.
85 */
d5477a8d 86struct nfs4_stid {
9767feb2 87 atomic_t sc_count;
d5477a8d
BF
88#define NFS4_OPEN_STID 1
89#define NFS4_LOCK_STID 2
90#define NFS4_DELEG_STID 4
f7a4d872
BF
91/* For an open stateid kept around *only* to process close replays: */
92#define NFS4_CLOSED_STID 8
3bd64a5b
BF
93/* For a deleg stateid kept around only to process free_stateid's: */
94#define NFS4_REVOKED_DELEG_STID 16
b0fc29d6 95#define NFS4_CLOSED_DELEG_STID 32
9cf514cc 96#define NFS4_LAYOUT_STID 64
9767feb2
JL
97 unsigned char sc_type;
98 stateid_t sc_stateid;
99 spinlock_t sc_lock;
100 struct nfs4_client *sc_client;
101 struct nfs4_file *sc_file;
102 void (*sc_free)(struct nfs4_stid *);
d5477a8d
BF
103};
104
14a571a8
JL
105/*
106 * Represents a delegation stateid. The nfs4_client holds references to these
107 * and they are put when it is being destroyed or when the delegation is
108 * returned by the client:
109 *
110 * o 1 reference as long as a delegation is still in force (taken when it's
111 * alloc'd, put when it's returned or revoked)
112 *
113 * o 1 reference as long as a recall rpc is in progress (taken when the lease
114 * is broken, put when the rpc exits)
115 *
116 * o 1 more ephemeral reference for each nfsd thread currently doing something
117 * with that delegation without holding the cl_lock
118 *
119 * If the server attempts to recall a delegation and the client doesn't do so
120 * before a timeout, the server may also revoke the delegation. In that case,
121 * the object will either be destroyed (v4.0) or moved to a per-client list of
122 * revoked delegations (v4.1+).
123 *
124 * This object is a superset of the nfs4_stid.
125 */
1da177e4 126struct nfs4_delegation {
996e0938 127 struct nfs4_stid dl_stid; /* must be first field */
ea1da636
N
128 struct list_head dl_perfile;
129 struct list_head dl_perclnt;
1da177e4 130 struct list_head dl_recall_lru; /* delegation recalled */
8287f009 131 struct nfs4_clnt_odstate *dl_clnt_odstate;
1da177e4
LT
132 u32 dl_type;
133 time_t dl_time;
b53d40c5 134/* For recall: */
3aea09dc 135 int dl_retries;
227f98d9 136 struct nfsd4_callback dl_recall;
1da177e4
LT
137};
138
34549ab0
JL
139#define cb_to_delegation(cb) \
140 container_of(cb, struct nfs4_delegation, dl_recall)
141
1da177e4 142/* client delegation callback info */
c237dc03 143struct nfs4_cb_conn {
1da177e4 144 /* SETCLIENTID info */
aa9a4ec7 145 struct sockaddr_storage cb_addr;
6f3d772f 146 struct sockaddr_storage cb_saddr;
aa9a4ec7 147 size_t cb_addrlen;
8b5ce5cd
BF
148 u32 cb_prog; /* used only in 4.0 case;
149 per-session otherwise */
ab52ae6d 150 u32 cb_ident; /* minorversion 0 only */
2bf23875 151 struct svc_xprt *cb_xprt; /* minorversion 1 only */
1da177e4
LT
152};
153
f459e453
BF
154static inline struct nfs4_delegation *delegstateid(struct nfs4_stid *s)
155{
156 return container_of(s, struct nfs4_delegation, dl_stid);
157}
158
a649637c
AA
159/* Maximum number of slots per session. 160 is useful for long haul TCP */
160#define NFSD_MAX_SLOTS_PER_SESSION 160
ec6b5d7b
AA
161/* Maximum number of operations per session compound */
162#define NFSD_MAX_OPS_PER_COMPOUND 16
557ce264 163/* Maximum session per slot cache size */
24906f32 164#define NFSD_SLOT_CACHE_SIZE 2048
a649637c
AA
165/* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
166#define NFSD_CACHE_SIZE_SLOTS_PER_SESSION 32
167#define NFSD_MAX_MEM_PER_SESSION \
168 (NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
074fe897 169
7116ed6b 170struct nfsd4_slot {
557ce264
AA
171 u32 sl_seqid;
172 __be32 sl_status;
173 u32 sl_datalen;
73e79482
BF
174 u16 sl_opcnt;
175#define NFSD4_SLOT_INUSE (1 << 0)
176#define NFSD4_SLOT_CACHETHIS (1 << 1)
bf5c43c8 177#define NFSD4_SLOT_INITIALIZED (1 << 2)
73e79482 178 u8 sl_flags;
557ce264 179 char sl_data[];
7116ed6b
AA
180};
181
6c18ba9f
AB
182struct nfsd4_channel_attrs {
183 u32 headerpadsz;
184 u32 maxreq_sz;
185 u32 maxresp_sz;
186 u32 maxresp_cached;
187 u32 maxops;
188 u32 maxreqs;
189 u32 nr_rdma_attrs;
190 u32 rdma_attrs;
191};
192
acb2887e 193struct nfsd4_cb_sec {
12fc3e92 194 u32 flavor; /* (u32)(-1) used to mean "no valid flavor" */
03bc6d1c
EB
195 kuid_t uid;
196 kgid_t gid;
acb2887e
BF
197};
198
49557cc7
AA
199struct nfsd4_create_session {
200 clientid_t clientid;
201 struct nfs4_sessionid sessionid;
202 u32 seqid;
203 u32 flags;
204 struct nfsd4_channel_attrs fore_channel;
205 struct nfsd4_channel_attrs back_channel;
206 u32 callback_prog;
acb2887e 207 struct nfsd4_cb_sec cb_sec;
49557cc7
AA
208};
209
cb73a9f4
BF
210struct nfsd4_backchannel_ctl {
211 u32 bc_cb_program;
212 struct nfsd4_cb_sec bc_cb_sec;
213};
214
1d1bc8f2
BF
215struct nfsd4_bind_conn_to_session {
216 struct nfs4_sessionid sessionid;
217 u32 dir;
218};
219
49557cc7
AA
220/* The single slot clientid cache structure */
221struct nfsd4_clid_slot {
222 u32 sl_seqid;
223 __be32 sl_status;
224 struct nfsd4_create_session sl_cr_ses;
225};
226
c7662518
BF
227struct nfsd4_conn {
228 struct list_head cn_persession;
229 struct svc_xprt *cn_xprt;
19cf5c02
BF
230 struct svc_xpt_user cn_xpt_user;
231 struct nfsd4_session *cn_session;
c7662518
BF
232/* CDFC4_FORE, CDFC4_BACK: */
233 unsigned char cn_flags;
234};
235
14a571a8
JL
236/*
237 * Representation of a v4.1+ session. These are refcounted in a similar fashion
238 * to the nfs4_client. References are only taken when the server is actively
239 * working on the object (primarily during the processing of compounds).
240 */
7116ed6b 241struct nfsd4_session {
66b2b9b2 242 atomic_t se_ref;
7116ed6b
AA
243 struct list_head se_hash; /* hash by sessionid */
244 struct list_head se_perclnt;
66b2b9b2
BF
245/* See SESSION4_PERSIST, etc. for standard flags; this is internal-only: */
246#define NFS4_SESSION_DEAD 0x010
7116ed6b 247 u32 se_flags;
07cd4909 248 struct nfs4_client *se_client;
7116ed6b 249 struct nfs4_sessionid se_sessionid;
6c18ba9f
AB
250 struct nfsd4_channel_attrs se_fchannel;
251 struct nfsd4_channel_attrs se_bchannel;
acb2887e 252 struct nfsd4_cb_sec se_cb_sec;
c7662518 253 struct list_head se_conns;
8b5ce5cd 254 u32 se_cb_prog;
ac7c46f2 255 u32 se_cb_seq_nr;
557ce264 256 struct nfsd4_slot *se_slots[]; /* forward channel slots */
7116ed6b
AA
257};
258
5282fd72
ME
259/* formatted contents of nfs4_sessionid */
260struct nfsd4_sessionid {
261 clientid_t clientid;
262 u32 sequence;
263 u32 reserved;
264};
265
a55370a3
N
266#define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */
267
1da177e4
LT
268/*
269 * struct nfs4_client - one per client. Clientids live here.
1da177e4 270 *
14a571a8
JL
271 * The initial object created by an NFS client using SETCLIENTID (for NFSv4.0)
272 * or EXCHANGE_ID (for NFSv4.1+). These objects are refcounted and timestamped.
273 * Each nfsd_net_ns object contains a set of these and they are tracked via
274 * short and long form clientid. They are hashed and searched for under the
275 * per-nfsd_net client_lock spinlock.
276 *
277 * References to it are only held during the processing of compounds, and in
278 * certain other operations. In their "resting state" they have a refcount of
279 * 0. If they are not renewed within a lease period, they become eligible for
280 * destruction by the laundromat.
281 *
282 * These objects can also be destroyed prematurely by the fault injection code,
283 * or if the client sends certain forms of SETCLIENTID or EXCHANGE_ID updates.
284 * Care is taken *not* to do this however when the objects have an elevated
285 * refcount.
286 *
287 * o Each nfs4_client is hashed by clientid
288 *
289 * o Each nfs4_clients is also hashed by name (the opaque quantity initially
290 * sent by the client to identify itself).
1da177e4 291 *
14a571a8
JL
292 * o cl_perclient list is used to ensure no dangling stateowner references
293 * when we expire the nfs4_client
1da177e4
LT
294 */
295struct nfs4_client {
296 struct list_head cl_idhash; /* hash by cl_clientid.id */
ac55fdc4 297 struct rb_node cl_namenode; /* link into by-name trees */
d4f0489f 298 struct list_head *cl_ownerstr_hashtbl;
ea1da636 299 struct list_head cl_openowners;
38c2f4b1 300 struct idr cl_stateids; /* stateid lookup */
ea1da636 301 struct list_head cl_delegations;
3bd64a5b 302 struct list_head cl_revoked; /* unacknowledged, revoked 4.1 state */
1da177e4 303 struct list_head cl_lru; /* tail queue */
9cf514cc
CH
304#ifdef CONFIG_NFSD_PNFS
305 struct list_head cl_lo_states; /* outstanding layout states */
306#endif
1da177e4
LT
307 struct xdr_netobj cl_name; /* id generated by client */
308 nfs4_verifier cl_verifier; /* generated by client */
309 time_t cl_time; /* time of last lease renewal */
363168b4 310 struct sockaddr_storage cl_addr; /* client ipaddress */
57266a6e 311 bool cl_mach_cred; /* SP4_MACH_CRED in force */
1da177e4
LT
312 struct svc_cred cl_cred; /* setclientid principal */
313 clientid_t cl_clientid; /* generated by server */
314 nfs4_verifier cl_confirm; /* generated by server */
8323c3b2 315 u32 cl_minorversion;
9fb87070 316
2bf23875
BF
317 /* for v4.0 and v4.1 callbacks: */
318 struct nfs4_cb_conn cl_cb_conn;
a52d726b
JL
319#define NFSD4_CLIENT_CB_UPDATE (0)
320#define NFSD4_CLIENT_CB_KILL (1)
321#define NFSD4_CLIENT_STABLE (2) /* client on stable storage */
322#define NFSD4_CLIENT_RECLAIM_COMPLETE (3) /* reclaim_complete done */
ac55fdc4 323#define NFSD4_CLIENT_CONFIRMED (4) /* client is confirmed */
d682e750 324#define NFSD4_CLIENT_UPCALL_LOCK (5) /* upcall serialization */
a52d726b
JL
325#define NFSD4_CLIENT_CB_FLAG_MASK (1 << NFSD4_CLIENT_CB_UPDATE | \
326 1 << NFSD4_CLIENT_CB_KILL)
327 unsigned long cl_flags;
c6bb3ca2 328 struct rpc_cred *cl_cb_cred;
2bf23875 329 struct rpc_clnt *cl_cb_client;
6ff8da08 330 u32 cl_cb_ident;
77a3569d
BF
331#define NFSD4_CB_UP 0
332#define NFSD4_CB_UNKNOWN 1
333#define NFSD4_CB_DOWN 2
5423732a 334#define NFSD4_CB_FAULT 3
77a3569d 335 int cl_cb_state;
cee277d9 336 struct nfsd4_callback cl_cb_null;
edd76786 337 struct nfsd4_session *cl_cb_session;
2bf23875 338
6ff8da08
BF
339 /* for all client information that callback code might need: */
340 spinlock_t cl_lock;
341
9fb87070
ME
342 /* for nfs41 */
343 struct list_head cl_sessions;
49557cc7 344 struct nfsd4_clid_slot cl_cs_slot; /* create_session slot */
0733d213 345 u32 cl_exchange_flags;
46583e25
BH
346 /* number of rpc's in progress over an associated session: */
347 atomic_t cl_refcount;
ed941643 348 struct nfs4_op_map cl_spo_must_allow;
38524ab3
AA
349
350 /* for nfs41 callbacks */
199ff35e
RL
351 /* We currently support a single back channel with a single slot */
352 unsigned long cl_cb_slot_busy;
199ff35e
RL
353 struct rpc_wait_queue cl_cb_waitq; /* backchannel callers may */
354 /* wait here for slots */
c212cecf 355 struct net *net;
1da177e4
LT
356};
357
358/* struct nfs4_client_reset
359 * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
360 * upon lease reset, or from upcall to state_daemon (to read in state
361 * from non-volitile storage) upon reboot.
362 */
363struct nfs4_client_reclaim {
364 struct list_head cr_strhash; /* hash by cr_name */
0ce0c2b5 365 struct nfs4_client *cr_clp; /* pointer to associated clp */
a55370a3 366 char cr_recdir[HEXDIR_LEN]; /* recover dir */
1da177e4
LT
367};
368
1da177e4
LT
369/* A reasonable value for REPLAY_ISIZE was estimated as follows:
370 * The OPEN response, typically the largest, requires
371 * 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) +
372 * 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
373 * 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
374 */
375
376#define NFSD4_REPLAY_ISIZE 112
377
378/*
379 * Replay buffer, where the result of the last seqid-mutating operation
380 * is cached.
381 */
382struct nfs4_replay {
b37ad28b 383 __be32 rp_status;
1da177e4
LT
384 unsigned int rp_buflen;
385 char *rp_buf;
a4773c08 386 struct knfsd_fh rp_openfh;
58fb12e6 387 struct mutex rp_mutex;
1da177e4
LT
388 char rp_ibuf[NFSD4_REPLAY_ISIZE];
389};
390
6b180f0b
JL
391struct nfs4_stateowner;
392
393struct nfs4_stateowner_operations {
8f4b54c5 394 void (*so_unhash)(struct nfs4_stateowner *);
6b180f0b
JL
395 void (*so_free)(struct nfs4_stateowner *);
396};
397
14a571a8
JL
398/*
399 * A core object that represents either an open or lock owner. The object and
400 * lock owner objects have one of these embedded within them. Refcounts and
401 * other fields common to both owner types are contained within these
402 * structures.
403 */
1da177e4 404struct nfs4_stateowner {
6b180f0b
JL
405 struct list_head so_strhash;
406 struct list_head so_stateids;
407 struct nfs4_client *so_client;
408 const struct nfs4_stateowner_operations *so_ops;
83e452fe 409 /* after increment in nfsd4_bump_seqid, represents the next
7fb64cee 410 * sequence id expected from the client: */
6b180f0b
JL
411 atomic_t so_count;
412 u32 so_seqid;
413 struct xdr_netobj so_owner; /* open owner name */
414 struct nfs4_replay so_replay;
415 bool so_is_open_owner;
1da177e4
LT
416};
417
14a571a8
JL
418/*
419 * When a file is opened, the client provides an open state owner opaque string
420 * that indicates the "owner" of that open. These objects are refcounted.
421 * References to it are held by each open state associated with it. This object
422 * is a superset of the nfs4_stateowner struct.
423 */
fe0750e5
BF
424struct nfs4_openowner {
425 struct nfs4_stateowner oo_owner; /* must be first field */
426 struct list_head oo_perclient;
b31b30e5
BF
427 /*
428 * We keep around openowners a little while after last close,
429 * which saves clients from having to confirm, and allows us to
430 * handle close replays if they come soon enough. The close_lru
431 * is a list of such openowners, to be reaped by the laundromat
432 * thread eventually if they remain unused:
433 */
434 struct list_head oo_close_lru;
38c387b5 435 struct nfs4_ol_stateid *oo_last_closed_stid;
fe0750e5 436 time_t oo_time; /* time of placement on so_close_lru */
dad1c067
BF
437#define NFS4_OO_CONFIRMED 1
438 unsigned char oo_flags;
fe0750e5
BF
439};
440
14a571a8
JL
441/*
442 * Represents a generic "lockowner". Similar to an openowner. References to it
443 * are held by the lock stateids that are created on its behalf. This object is
444 * a superset of the nfs4_stateowner struct (or would be if it needed any extra
445 * fields).
446 */
fe0750e5
BF
447struct nfs4_lockowner {
448 struct nfs4_stateowner lo_owner; /* must be first element */
fe0750e5
BF
449};
450
451static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so)
452{
453 return container_of(so, struct nfs4_openowner, oo_owner);
454}
455
456static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so)
457{
458 return container_of(so, struct nfs4_lockowner, lo_owner);
459}
460
8287f009
SB
461/*
462 * Per-client state indicating no. of opens and outstanding delegations
463 * on a file from a particular client.'od' stands for 'open & delegation'
464 */
465struct nfs4_clnt_odstate {
466 struct nfs4_client *co_client;
467 struct nfs4_file *co_file;
468 struct list_head co_perfile;
469 atomic_t co_odcount;
470};
471
14a571a8
JL
472/*
473 * nfs4_file: a file opened by some number of (open) nfs4_stateowners.
474 *
ccc6398e
JL
475 * These objects are global. nfsd keeps one instance of a nfs4_file per
476 * filehandle (though it may keep multiple file descriptors for each). Each
477 * inode can have multiple filehandles associated with it, so there is
478 * (potentially) a many to one relationship between this struct and struct
479 * inode.
480 *
481 * These are hashed by filehandle in the file_hashtbl, which is protected by
482 * the global state_lock spinlock.
14a571a8 483 */
1da177e4 484struct nfs4_file {
8b671b80 485 atomic_t fi_ref;
1d31a253 486 spinlock_t fi_lock;
ccc6398e 487 struct hlist_node fi_hash; /* hash on fi_fhandle */
8beefa24 488 struct list_head fi_stateids;
5b095e99
JL
489 union {
490 struct list_head fi_delegations;
491 struct rcu_head fi_rcu;
492 };
8287f009 493 struct list_head fi_clnt_odstate;
f9d7562f
BF
494 /* One each for O_RDONLY, O_WRONLY, O_RDWR: */
495 struct file * fi_fds[3];
f9d7562f 496 /*
6409a5a6
BF
497 * Each open or lock stateid contributes 0-4 to the counts
498 * below depending on which bits are set in st_access_bitmap:
499 * 1 to fi_access[O_RDONLY] if NFS4_SHARE_ACCES_READ is set
500 * + 1 to fi_access[O_WRONLY] if NFS4_SHARE_ACCESS_WRITE is set
501 * + 1 to both of the above if NFS4_SHARE_ACCESS_BOTH is set.
f9d7562f 502 */
9ae78bcc 503 atomic_t fi_access[2];
baeb4ff0 504 u32 fi_share_deny;
acfdf5c3 505 struct file *fi_deleg_file;
67db1034 506 int fi_delegees;
e2cf80d7 507 struct knfsd_fh fi_fhandle;
47f9940c 508 bool fi_had_conflict;
9cf514cc
CH
509#ifdef CONFIG_NFSD_PNFS
510 struct list_head fi_lo_states;
c5c707f9 511 atomic_t fi_lo_recalls;
9cf514cc 512#endif
1da177e4
LT
513};
514
14a571a8
JL
515/*
516 * A generic struct representing either a open or lock stateid. The nfs4_client
517 * holds a reference to each of these objects, and they in turn hold a
518 * reference to their respective stateowners. The client's reference is
519 * released in response to a close or unlock (depending on whether it's an open
520 * or lock stateid) or when the client is being destroyed.
521 *
522 * In the case of v4.0 open stateids, these objects are preserved for a little
523 * while after close in order to handle CLOSE replays. Those are eventually
524 * reclaimed via a LRU scheme by the laundromat.
525 *
526 * This object is a superset of the nfs4_stid. "ol" stands for "Open or Lock".
527 * Better suggestions welcome.
528 */
dcef0413 529struct nfs4_ol_stateid {
35a92fe8
JL
530 struct nfs4_stid st_stid;
531 struct list_head st_perfile;
532 struct list_head st_perstateowner;
533 struct list_head st_locks;
534 struct nfs4_stateowner *st_stateowner;
535 struct nfs4_clnt_odstate *st_clnt_odstate;
536 unsigned char st_access_bmap;
537 unsigned char st_deny_bmap;
538 struct nfs4_ol_stateid *st_openstp;
feb9dad5 539 struct mutex st_mutex;
1da177e4
LT
540};
541
dcef0413
BF
542static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s)
543{
544 return container_of(s, struct nfs4_ol_stateid, st_stid);
545}
546
9cf514cc
CH
547struct nfs4_layout_stateid {
548 struct nfs4_stid ls_stid;
549 struct list_head ls_perclnt;
550 struct list_head ls_perfile;
551 spinlock_t ls_lock;
552 struct list_head ls_layouts;
553 u32 ls_layout_type;
c5c707f9
CH
554 struct file *ls_file;
555 struct nfsd4_callback ls_recall;
556 stateid_t ls_recall_sid;
557 bool ls_recalled;
cc8a5532 558 struct mutex ls_mutex;
9cf514cc
CH
559};
560
561static inline struct nfs4_layout_stateid *layoutstateid(struct nfs4_stid *s)
562{
563 return container_of(s, struct nfs4_layout_stateid, ls_stid);
564}
565
1da177e4 566/* flags for preprocess_seqid_op() */
1da177e4
LT
567#define RD_STATE 0x00000010
568#define WR_STATE 0x00000020
1da177e4 569
326129d0
CH
570enum nfsd4_cb_op {
571 NFSPROC4_CLNT_CB_NULL = 0,
572 NFSPROC4_CLNT_CB_RECALL,
c5c707f9 573 NFSPROC4_CLNT_CB_LAYOUT,
326129d0
CH
574 NFSPROC4_CLNT_CB_SEQUENCE,
575};
576
14b7f4a1
JL
577/* 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}
326129d0 582
dd453dfd 583struct nfsd4_compound_state;
2c142baa 584struct nfsd_net;
dd453dfd 585
af90f707 586extern __be32 nfs4_preprocess_stateid_op(struct svc_rqst *rqstp,
aa0d6aed
AS
587 struct nfsd4_compound_state *cstate, struct svc_fh *fhp,
588 stateid_t *stateid, int flags, struct file **filp, bool *tmp_file);
cd61c522
CH
589__be32 nfsd4_lookup_stateid(struct nfsd4_compound_state *cstate,
590 stateid_t *stateid, unsigned char typemask,
591 struct nfs4_stid **s, struct nfsd_net *nn);
592struct nfs4_stid *nfs4_alloc_stid(struct nfs4_client *cl,
593 struct kmem_cache *slab);
594void nfs4_unhash_stid(struct nfs4_stid *s);
6011695d 595void nfs4_put_stid(struct nfs4_stid *s);
9767feb2 596void nfs4_inc_and_copy_stateid(stateid_t *dst, struct nfs4_stid *stid);
52e19c09
SK
597void nfs4_remove_reclaim_record(struct nfs4_client_reclaim *, struct nfsd_net *);
598extern void nfs4_release_reclaim(struct nfsd_net *);
599extern struct nfs4_client_reclaim *nfsd4_find_reclaim_client(const char *recdir,
600 struct nfsd_net *nn);
0fe492db
TM
601extern __be32 nfs4_check_open_reclaim(clientid_t *clid,
602 struct nfsd4_compound_state *cstate, struct nfsd_net *nn);
80fc015b 603extern int set_callback_cred(void);
5a3c9d71 604extern void nfsd4_probe_callback(struct nfs4_client *clp);
84f5f7cc 605extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
5a3c9d71 606extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
f0b5de1b 607extern void nfsd4_init_cb(struct nfsd4_callback *cb, struct nfs4_client *clp,
c4cb8974 608 const struct nfsd4_callback_ops *ops, enum nfsd4_cb_op op);
f0b5de1b 609extern void nfsd4_run_cb(struct nfsd4_callback *cb);
b5a1a81e
BF
610extern int nfsd4_create_callback_queue(void);
611extern void nfsd4_destroy_callback_queue(void);
6ff8da08 612extern void nfsd4_shutdown_callback(struct nfs4_client *);
02e1215f 613extern void nfsd4_prepare_cb_recall(struct nfs4_delegation *dp);
52e19c09
SK
614extern struct nfs4_client_reclaim *nfs4_client_to_reclaim(const char *name,
615 struct nfsd_net *nn);
616extern bool nfs4_has_reclaimed_state(const char *name, struct nfsd_net *nn);
1da177e4 617
e6ba76e1
CH
618struct nfs4_file *find_file(struct knfsd_fh *fh);
619void put_nfs4_file(struct nfs4_file *fi);
620static inline void get_nfs4_file(struct nfs4_file *fi)
621{
622 atomic_inc(&fi->fi_ref);
623}
4d227fca 624struct file *find_any_file(struct nfs4_file *f);
e6ba76e1 625
7f5ef2e9
JL
626/* grace period management */
627void nfsd4_end_grace(struct nfsd_net *nn);
628
2a4317c5
JL
629/* nfs4recover operations */
630extern int nfsd4_client_tracking_init(struct net *net);
631extern void nfsd4_client_tracking_exit(struct net *net);
632extern void nfsd4_client_record_create(struct nfs4_client *clp);
633extern void nfsd4_client_record_remove(struct nfs4_client *clp);
634extern int nfsd4_client_record_check(struct nfs4_client *clp);
919b8049 635extern void nfsd4_record_grace_done(struct nfsd_net *nn);
f3c7521f
BS
636
637/* nfs fault injection functions */
638#ifdef CONFIG_NFSD_FAULT_INJECTION
639int nfsd_fault_inject_init(void);
640void nfsd_fault_inject_cleanup(void);
285abdee
JL
641
642u64 nfsd_inject_print_clients(void);
643u64 nfsd_inject_forget_client(struct sockaddr_storage *, size_t);
644u64 nfsd_inject_forget_clients(u64);
645
646u64 nfsd_inject_print_locks(void);
647u64 nfsd_inject_forget_client_locks(struct sockaddr_storage *, size_t);
648u64 nfsd_inject_forget_locks(u64);
649
650u64 nfsd_inject_print_openowners(void);
651u64 nfsd_inject_forget_client_openowners(struct sockaddr_storage *, size_t);
652u64 nfsd_inject_forget_openowners(u64);
653
654u64 nfsd_inject_print_delegations(void);
655u64 nfsd_inject_forget_client_delegations(struct sockaddr_storage *, size_t);
656u64 nfsd_inject_forget_delegations(u64);
657u64 nfsd_inject_recall_client_delegations(struct sockaddr_storage *, size_t);
658u64 nfsd_inject_recall_delegations(u64);
f3c7521f
BS
659#else /* CONFIG_NFSD_FAULT_INJECTION */
660static inline int nfsd_fault_inject_init(void) { return 0; }
661static inline void nfsd_fault_inject_cleanup(void) {}
662#endif /* CONFIG_NFSD_FAULT_INJECTION */
663
1da177e4 664#endif /* NFSD4_STATE_H */