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