Loading...
1/*
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
38#include <linux/idr.h>
39#include <linux/sunrpc/svc_xprt.h>
40#include "nfsfh.h"
41
42typedef struct {
43 u32 cl_boot;
44 u32 cl_id;
45} clientid_t;
46
47typedef struct {
48 clientid_t so_clid;
49 u32 so_id;
50} stateid_opaque_t;
51
52typedef struct {
53 u32 si_generation;
54 stateid_opaque_t si_opaque;
55} stateid_t;
56
57#define STATEID_FMT "(%08x/%08x/%08x/%08x)"
58#define STATEID_VAL(s) \
59 (s)->si_opaque.so_clid.cl_boot, \
60 (s)->si_opaque.so_clid.cl_id, \
61 (s)->si_opaque.so_id, \
62 (s)->si_generation
63
64struct nfsd4_callback {
65 struct nfs4_client *cb_clp;
66 u32 cb_minorversion;
67 struct rpc_message cb_msg;
68 const struct nfsd4_callback_ops *cb_ops;
69 struct work_struct cb_work;
70 int cb_seq_status;
71 int cb_status;
72 bool cb_need_restart;
73};
74
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
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 */
86struct nfs4_stid {
87 atomic_t sc_count;
88#define NFS4_OPEN_STID 1
89#define NFS4_LOCK_STID 2
90#define NFS4_DELEG_STID 4
91/* For an open stateid kept around *only* to process close replays: */
92#define NFS4_CLOSED_STID 8
93/* For a deleg stateid kept around only to process free_stateid's: */
94#define NFS4_REVOKED_DELEG_STID 16
95#define NFS4_CLOSED_DELEG_STID 32
96#define NFS4_LAYOUT_STID 64
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 *);
103};
104
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 */
126struct nfs4_delegation {
127 struct nfs4_stid dl_stid; /* must be first field */
128 struct list_head dl_perfile;
129 struct list_head dl_perclnt;
130 struct list_head dl_recall_lru; /* delegation recalled */
131 struct nfs4_clnt_odstate *dl_clnt_odstate;
132 u32 dl_type;
133 time_t dl_time;
134/* For recall: */
135 int dl_retries;
136 struct nfsd4_callback dl_recall;
137};
138
139#define cb_to_delegation(cb) \
140 container_of(cb, struct nfs4_delegation, dl_recall)
141
142/* client delegation callback info */
143struct nfs4_cb_conn {
144 /* SETCLIENTID info */
145 struct sockaddr_storage cb_addr;
146 struct sockaddr_storage cb_saddr;
147 size_t cb_addrlen;
148 u32 cb_prog; /* used only in 4.0 case;
149 per-session otherwise */
150 u32 cb_ident; /* minorversion 0 only */
151 struct svc_xprt *cb_xprt; /* minorversion 1 only */
152};
153
154static inline struct nfs4_delegation *delegstateid(struct nfs4_stid *s)
155{
156 return container_of(s, struct nfs4_delegation, dl_stid);
157}
158
159/* Maximum number of slots per session. 160 is useful for long haul TCP */
160#define NFSD_MAX_SLOTS_PER_SESSION 160
161/* Maximum number of operations per session compound */
162#define NFSD_MAX_OPS_PER_COMPOUND 16
163/* Maximum session per slot cache size */
164#define NFSD_SLOT_CACHE_SIZE 2048
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)
169
170struct nfsd4_slot {
171 u32 sl_seqid;
172 __be32 sl_status;
173 u32 sl_datalen;
174 u16 sl_opcnt;
175#define NFSD4_SLOT_INUSE (1 << 0)
176#define NFSD4_SLOT_CACHETHIS (1 << 1)
177#define NFSD4_SLOT_INITIALIZED (1 << 2)
178 u8 sl_flags;
179 char sl_data[];
180};
181
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
193struct nfsd4_cb_sec {
194 u32 flavor; /* (u32)(-1) used to mean "no valid flavor" */
195 kuid_t uid;
196 kgid_t gid;
197};
198
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;
207 struct nfsd4_cb_sec cb_sec;
208};
209
210struct nfsd4_backchannel_ctl {
211 u32 bc_cb_program;
212 struct nfsd4_cb_sec bc_cb_sec;
213};
214
215struct nfsd4_bind_conn_to_session {
216 struct nfs4_sessionid sessionid;
217 u32 dir;
218};
219
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
227struct nfsd4_conn {
228 struct list_head cn_persession;
229 struct svc_xprt *cn_xprt;
230 struct svc_xpt_user cn_xpt_user;
231 struct nfsd4_session *cn_session;
232/* CDFC4_FORE, CDFC4_BACK: */
233 unsigned char cn_flags;
234};
235
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 */
241struct nfsd4_session {
242 atomic_t se_ref;
243 struct list_head se_hash; /* hash by sessionid */
244 struct list_head se_perclnt;
245/* See SESSION4_PERSIST, etc. for standard flags; this is internal-only: */
246#define NFS4_SESSION_DEAD 0x010
247 u32 se_flags;
248 struct nfs4_client *se_client;
249 struct nfs4_sessionid se_sessionid;
250 struct nfsd4_channel_attrs se_fchannel;
251 struct nfsd4_channel_attrs se_bchannel;
252 struct nfsd4_cb_sec se_cb_sec;
253 struct list_head se_conns;
254 u32 se_cb_prog;
255 u32 se_cb_seq_nr;
256 struct nfsd4_slot *se_slots[]; /* forward channel slots */
257};
258
259/* formatted contents of nfs4_sessionid */
260struct nfsd4_sessionid {
261 clientid_t clientid;
262 u32 sequence;
263 u32 reserved;
264};
265
266#define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */
267
268/*
269 * struct nfs4_client - one per client. Clientids live here.
270 *
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).
291 *
292 * o cl_perclient list is used to ensure no dangling stateowner references
293 * when we expire the nfs4_client
294 */
295struct nfs4_client {
296 struct list_head cl_idhash; /* hash by cl_clientid.id */
297 struct rb_node cl_namenode; /* link into by-name trees */
298 struct list_head *cl_ownerstr_hashtbl;
299 struct list_head cl_openowners;
300 struct idr cl_stateids; /* stateid lookup */
301 struct list_head cl_delegations;
302 struct list_head cl_revoked; /* unacknowledged, revoked 4.1 state */
303 struct list_head cl_lru; /* tail queue */
304#ifdef CONFIG_NFSD_PNFS
305 struct list_head cl_lo_states; /* outstanding layout states */
306#endif
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 */
310 struct sockaddr_storage cl_addr; /* client ipaddress */
311 bool cl_mach_cred; /* SP4_MACH_CRED in force */
312 struct svc_cred cl_cred; /* setclientid principal */
313 clientid_t cl_clientid; /* generated by server */
314 nfs4_verifier cl_confirm; /* generated by server */
315 u32 cl_minorversion;
316
317 /* for v4.0 and v4.1 callbacks: */
318 struct nfs4_cb_conn cl_cb_conn;
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 */
323#define NFSD4_CLIENT_CONFIRMED (4) /* client is confirmed */
324#define NFSD4_CLIENT_UPCALL_LOCK (5) /* upcall serialization */
325#define NFSD4_CLIENT_CB_FLAG_MASK (1 << NFSD4_CLIENT_CB_UPDATE | \
326 1 << NFSD4_CLIENT_CB_KILL)
327 unsigned long cl_flags;
328 struct rpc_cred *cl_cb_cred;
329 struct rpc_clnt *cl_cb_client;
330 u32 cl_cb_ident;
331#define NFSD4_CB_UP 0
332#define NFSD4_CB_UNKNOWN 1
333#define NFSD4_CB_DOWN 2
334#define NFSD4_CB_FAULT 3
335 int cl_cb_state;
336 struct nfsd4_callback cl_cb_null;
337 struct nfsd4_session *cl_cb_session;
338
339 /* for all client information that callback code might need: */
340 spinlock_t cl_lock;
341
342 /* for nfs41 */
343 struct list_head cl_sessions;
344 struct nfsd4_clid_slot cl_cs_slot; /* create_session slot */
345 u32 cl_exchange_flags;
346 /* number of rpc's in progress over an associated session: */
347 atomic_t cl_refcount;
348
349 /* for nfs41 callbacks */
350 /* We currently support a single back channel with a single slot */
351 unsigned long cl_cb_slot_busy;
352 struct rpc_wait_queue cl_cb_waitq; /* backchannel callers may */
353 /* wait here for slots */
354 struct net *net;
355};
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 */
364 struct nfs4_client *cr_clp; /* pointer to associated clp */
365 char cr_recdir[HEXDIR_LEN]; /* recover dir */
366};
367
368/* 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 {
382 __be32 rp_status;
383 unsigned int rp_buflen;
384 char *rp_buf;
385 struct knfsd_fh rp_openfh;
386 struct mutex rp_mutex;
387 char rp_ibuf[NFSD4_REPLAY_ISIZE];
388};
389
390struct nfs4_stateowner;
391
392struct nfs4_stateowner_operations {
393 void (*so_unhash)(struct nfs4_stateowner *);
394 void (*so_free)(struct nfs4_stateowner *);
395};
396
397/*
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 */
403struct nfs4_stateowner {
404 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;
408 /* after increment in nfsd4_bump_seqid, represents the next
409 * sequence id expected from the client: */
410 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;
415};
416
417/*
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 */
423struct nfs4_openowner {
424 struct nfs4_stateowner oo_owner; /* must be first field */
425 struct list_head oo_perclient;
426 /*
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;
434 struct nfs4_ol_stateid *oo_last_closed_stid;
435 time_t oo_time; /* time of placement on so_close_lru */
436#define NFS4_OO_CONFIRMED 1
437 unsigned char oo_flags;
438};
439
440/*
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
443 * a superset of the nfs4_stateowner struct (or would be if it needed any extra
444 * fields).
445 */
446struct nfs4_lockowner {
447 struct nfs4_stateowner lo_owner; /* must be first element */
448};
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
460/*
461 * 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/*
472 * nfs4_file: a file opened by some number of (open) nfs4_stateowners.
473 *
474 * 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.
482 */
483struct nfs4_file {
484 atomic_t fi_ref;
485 spinlock_t fi_lock;
486 struct hlist_node fi_hash; /* hash on fi_fhandle */
487 struct list_head fi_stateids;
488 union {
489 struct list_head fi_delegations;
490 struct rcu_head fi_rcu;
491 };
492 struct list_head fi_clnt_odstate;
493 /* One each for O_RDONLY, O_WRONLY, O_RDWR: */
494 struct file * fi_fds[3];
495 /*
496 * 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.
501 */
502 atomic_t fi_access[2];
503 u32 fi_share_deny;
504 struct file *fi_deleg_file;
505 int fi_delegees;
506 struct knfsd_fh fi_fhandle;
507 bool fi_had_conflict;
508#ifdef CONFIG_NFSD_PNFS
509 struct list_head fi_lo_states;
510 atomic_t fi_lo_recalls;
511#endif
512};
513
514/*
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 */
528struct nfs4_ol_stateid {
529 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;
538 struct rw_semaphore st_rwsem;
539};
540
541static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s)
542{
543 return container_of(s, struct nfs4_ol_stateid, st_stid);
544}
545
546struct 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;
553 struct file *ls_file;
554 struct nfsd4_callback ls_recall;
555 stateid_t ls_recall_sid;
556 bool ls_recalled;
557 struct mutex ls_mutex;
558};
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
565/* flags for preprocess_seqid_op() */
566#define RD_STATE 0x00000010
567#define WR_STATE 0x00000020
568
569enum nfsd4_cb_op {
570 NFSPROC4_CLNT_CB_NULL = 0,
571 NFSPROC4_CLNT_CB_RECALL,
572 NFSPROC4_CLNT_CB_LAYOUT,
573 NFSPROC4_CLNT_CB_SEQUENCE,
574};
575
576
577struct nfsd4_compound_state;
578struct nfsd_net;
579
580extern __be32 nfs4_preprocess_stateid_op(struct svc_rqst *rqstp,
581 struct nfsd4_compound_state *cstate, struct svc_fh *fhp,
582 stateid_t *stateid, int flags, struct file **filp, bool *tmp_file);
583__be32 nfsd4_lookup_stateid(struct nfsd4_compound_state *cstate,
584 stateid_t *stateid, unsigned char typemask,
585 struct nfs4_stid **s, struct nfsd_net *nn);
586struct nfs4_stid *nfs4_alloc_stid(struct nfs4_client *cl,
587 struct kmem_cache *slab);
588void nfs4_unhash_stid(struct nfs4_stid *s);
589void nfs4_put_stid(struct nfs4_stid *s);
590void nfs4_inc_and_copy_stateid(stateid_t *dst, struct nfs4_stid *stid);
591void nfs4_remove_reclaim_record(struct nfs4_client_reclaim *, struct nfsd_net *);
592extern void nfs4_release_reclaim(struct nfsd_net *);
593extern struct nfs4_client_reclaim *nfsd4_find_reclaim_client(const char *recdir,
594 struct nfsd_net *nn);
595extern __be32 nfs4_check_open_reclaim(clientid_t *clid,
596 struct nfsd4_compound_state *cstate, struct nfsd_net *nn);
597extern int set_callback_cred(void);
598extern void nfsd4_probe_callback(struct nfs4_client *clp);
599extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
600extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
601extern void nfsd4_init_cb(struct nfsd4_callback *cb, struct nfs4_client *clp,
602 const struct nfsd4_callback_ops *ops, enum nfsd4_cb_op op);
603extern void nfsd4_run_cb(struct nfsd4_callback *cb);
604extern int nfsd4_create_callback_queue(void);
605extern void nfsd4_destroy_callback_queue(void);
606extern void nfsd4_shutdown_callback(struct nfs4_client *);
607extern void nfsd4_prepare_cb_recall(struct nfs4_delegation *dp);
608extern struct nfs4_client_reclaim *nfs4_client_to_reclaim(const char *name,
609 struct nfsd_net *nn);
610extern bool nfs4_has_reclaimed_state(const char *name, struct nfsd_net *nn);
611
612struct nfs4_file *find_file(struct knfsd_fh *fh);
613void put_nfs4_file(struct nfs4_file *fi);
614static inline void get_nfs4_file(struct nfs4_file *fi)
615{
616 atomic_inc(&fi->fi_ref);
617}
618struct file *find_any_file(struct nfs4_file *f);
619
620/* grace period management */
621void nfsd4_end_grace(struct nfsd_net *nn);
622
623/* nfs4recover operations */
624extern int nfsd4_client_tracking_init(struct net *net);
625extern void nfsd4_client_tracking_exit(struct net *net);
626extern void nfsd4_client_record_create(struct nfs4_client *clp);
627extern void nfsd4_client_record_remove(struct nfs4_client *clp);
628extern int nfsd4_client_record_check(struct nfs4_client *clp);
629extern void nfsd4_record_grace_done(struct nfsd_net *nn);
630
631/* nfs fault injection functions */
632#ifdef CONFIG_NFSD_FAULT_INJECTION
633int nfsd_fault_inject_init(void);
634void nfsd_fault_inject_cleanup(void);
635
636u64 nfsd_inject_print_clients(void);
637u64 nfsd_inject_forget_client(struct sockaddr_storage *, size_t);
638u64 nfsd_inject_forget_clients(u64);
639
640u64 nfsd_inject_print_locks(void);
641u64 nfsd_inject_forget_client_locks(struct sockaddr_storage *, size_t);
642u64 nfsd_inject_forget_locks(u64);
643
644u64 nfsd_inject_print_openowners(void);
645u64 nfsd_inject_forget_client_openowners(struct sockaddr_storage *, size_t);
646u64 nfsd_inject_forget_openowners(u64);
647
648u64 nfsd_inject_print_delegations(void);
649u64 nfsd_inject_forget_client_delegations(struct sockaddr_storage *, size_t);
650u64 nfsd_inject_forget_delegations(u64);
651u64 nfsd_inject_recall_client_delegations(struct sockaddr_storage *, size_t);
652u64 nfsd_inject_recall_delegations(u64);
653#else /* CONFIG_NFSD_FAULT_INJECTION */
654static inline int nfsd_fault_inject_init(void) { return 0; }
655static inline void nfsd_fault_inject_cleanup(void) {}
656#endif /* CONFIG_NFSD_FAULT_INJECTION */
657
658#endif /* NFSD4_STATE_H */
1/*
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
38#include <linux/idr.h>
39#include <linux/sunrpc/svc_xprt.h>
40#include <linux/nfsd/nfsfh.h>
41#include "nfsfh.h"
42
43typedef struct {
44 u32 cl_boot;
45 u32 cl_id;
46} clientid_t;
47
48typedef struct {
49 clientid_t so_clid;
50 u32 so_id;
51} stateid_opaque_t;
52
53typedef struct {
54 u32 si_generation;
55 stateid_opaque_t si_opaque;
56} stateid_t;
57
58#define STATEID_FMT "(%08x/%08x/%08x/%08x)"
59#define STATEID_VAL(s) \
60 (s)->si_opaque.so_clid.cl_boot, \
61 (s)->si_opaque.so_clid.cl_id, \
62 (s)->si_opaque.so_id, \
63 (s)->si_generation
64
65struct nfsd4_callback {
66 void *cb_op;
67 struct nfs4_client *cb_clp;
68 struct list_head cb_per_client;
69 u32 cb_minorversion;
70 struct rpc_message cb_msg;
71 const struct rpc_call_ops *cb_ops;
72 struct work_struct cb_work;
73 bool cb_done;
74};
75
76struct nfs4_stid {
77#define NFS4_OPEN_STID 1
78#define NFS4_LOCK_STID 2
79#define NFS4_DELEG_STID 4
80/* For an open stateid kept around *only* to process close replays: */
81#define NFS4_CLOSED_STID 8
82 unsigned char sc_type;
83 stateid_t sc_stateid;
84 struct nfs4_client *sc_client;
85};
86
87struct nfs4_delegation {
88 struct nfs4_stid dl_stid; /* must be first field */
89 struct list_head dl_perfile;
90 struct list_head dl_perclnt;
91 struct list_head dl_recall_lru; /* delegation recalled */
92 atomic_t dl_count; /* ref count */
93 struct nfs4_file *dl_file;
94 u32 dl_type;
95 time_t dl_time;
96/* For recall: */
97 struct knfsd_fh dl_fh;
98 int dl_retries;
99 struct nfsd4_callback dl_recall;
100};
101
102/* client delegation callback info */
103struct nfs4_cb_conn {
104 /* SETCLIENTID info */
105 struct sockaddr_storage cb_addr;
106 struct sockaddr_storage cb_saddr;
107 size_t cb_addrlen;
108 u32 cb_prog; /* used only in 4.0 case;
109 per-session otherwise */
110 u32 cb_ident; /* minorversion 0 only */
111 struct svc_xprt *cb_xprt; /* minorversion 1 only */
112};
113
114static inline struct nfs4_delegation *delegstateid(struct nfs4_stid *s)
115{
116 return container_of(s, struct nfs4_delegation, dl_stid);
117}
118
119/* Maximum number of slots per session. 160 is useful for long haul TCP */
120#define NFSD_MAX_SLOTS_PER_SESSION 160
121/* Maximum number of operations per session compound */
122#define NFSD_MAX_OPS_PER_COMPOUND 16
123/* Maximum session per slot cache size */
124#define NFSD_SLOT_CACHE_SIZE 1024
125/* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
126#define NFSD_CACHE_SIZE_SLOTS_PER_SESSION 32
127#define NFSD_MAX_MEM_PER_SESSION \
128 (NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
129
130struct nfsd4_slot {
131 u32 sl_seqid;
132 __be32 sl_status;
133 u32 sl_datalen;
134 u16 sl_opcnt;
135#define NFSD4_SLOT_INUSE (1 << 0)
136#define NFSD4_SLOT_CACHETHIS (1 << 1)
137#define NFSD4_SLOT_INITIALIZED (1 << 2)
138 u8 sl_flags;
139 char sl_data[];
140};
141
142struct nfsd4_channel_attrs {
143 u32 headerpadsz;
144 u32 maxreq_sz;
145 u32 maxresp_sz;
146 u32 maxresp_cached;
147 u32 maxops;
148 u32 maxreqs;
149 u32 nr_rdma_attrs;
150 u32 rdma_attrs;
151};
152
153struct nfsd4_create_session {
154 clientid_t clientid;
155 struct nfs4_sessionid sessionid;
156 u32 seqid;
157 u32 flags;
158 struct nfsd4_channel_attrs fore_channel;
159 struct nfsd4_channel_attrs back_channel;
160 u32 callback_prog;
161 u32 uid;
162 u32 gid;
163};
164
165struct nfsd4_bind_conn_to_session {
166 struct nfs4_sessionid sessionid;
167 u32 dir;
168};
169
170/* The single slot clientid cache structure */
171struct nfsd4_clid_slot {
172 u32 sl_seqid;
173 __be32 sl_status;
174 struct nfsd4_create_session sl_cr_ses;
175};
176
177struct nfsd4_conn {
178 struct list_head cn_persession;
179 struct svc_xprt *cn_xprt;
180 struct svc_xpt_user cn_xpt_user;
181 struct nfsd4_session *cn_session;
182/* CDFC4_FORE, CDFC4_BACK: */
183 unsigned char cn_flags;
184};
185
186struct nfsd4_session {
187 struct kref se_ref;
188 struct list_head se_hash; /* hash by sessionid */
189 struct list_head se_perclnt;
190 u32 se_flags;
191 struct nfs4_client *se_client;
192 struct nfs4_sessionid se_sessionid;
193 struct nfsd4_channel_attrs se_fchannel;
194 struct nfsd4_channel_attrs se_bchannel;
195 struct list_head se_conns;
196 u32 se_cb_prog;
197 u32 se_cb_seq_nr;
198 struct nfsd4_slot *se_slots[]; /* forward channel slots */
199};
200
201extern void nfsd4_put_session(struct nfsd4_session *ses);
202
203/* formatted contents of nfs4_sessionid */
204struct nfsd4_sessionid {
205 clientid_t clientid;
206 u32 sequence;
207 u32 reserved;
208};
209
210#define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */
211
212/*
213 * struct nfs4_client - one per client. Clientids live here.
214 * o Each nfs4_client is hashed by clientid.
215 *
216 * o Each nfs4_clients is also hashed by name
217 * (the opaque quantity initially sent by the client to identify itself).
218 *
219 * o cl_perclient list is used to ensure no dangling stateowner references
220 * when we expire the nfs4_client
221 */
222struct nfs4_client {
223 struct list_head cl_idhash; /* hash by cl_clientid.id */
224 struct list_head cl_strhash; /* hash by cl_name */
225 struct list_head cl_openowners;
226 struct idr cl_stateids; /* stateid lookup */
227 struct list_head cl_delegations;
228 struct list_head cl_lru; /* tail queue */
229 struct xdr_netobj cl_name; /* id generated by client */
230 char cl_recdir[HEXDIR_LEN]; /* recovery dir */
231 nfs4_verifier cl_verifier; /* generated by client */
232 time_t cl_time; /* time of last lease renewal */
233 struct sockaddr_storage cl_addr; /* client ipaddress */
234 struct svc_cred cl_cred; /* setclientid principal */
235 clientid_t cl_clientid; /* generated by server */
236 nfs4_verifier cl_confirm; /* generated by server */
237 u32 cl_minorversion;
238
239 /* for v4.0 and v4.1 callbacks: */
240 struct nfs4_cb_conn cl_cb_conn;
241#define NFSD4_CLIENT_CB_UPDATE (0)
242#define NFSD4_CLIENT_CB_KILL (1)
243#define NFSD4_CLIENT_STABLE (2) /* client on stable storage */
244#define NFSD4_CLIENT_RECLAIM_COMPLETE (3) /* reclaim_complete done */
245#define NFSD4_CLIENT_CB_FLAG_MASK (1 << NFSD4_CLIENT_CB_UPDATE | \
246 1 << NFSD4_CLIENT_CB_KILL)
247 unsigned long cl_flags;
248 struct rpc_clnt *cl_cb_client;
249 u32 cl_cb_ident;
250#define NFSD4_CB_UP 0
251#define NFSD4_CB_UNKNOWN 1
252#define NFSD4_CB_DOWN 2
253#define NFSD4_CB_FAULT 3
254 int cl_cb_state;
255 struct nfsd4_callback cl_cb_null;
256 struct nfsd4_session *cl_cb_session;
257 struct list_head cl_callbacks; /* list of in-progress callbacks */
258
259 /* for all client information that callback code might need: */
260 spinlock_t cl_lock;
261
262 /* for nfs41 */
263 struct list_head cl_sessions;
264 struct nfsd4_clid_slot cl_cs_slot; /* create_session slot */
265 u32 cl_exchange_flags;
266 /* number of rpc's in progress over an associated session: */
267 atomic_t cl_refcount;
268
269 /* for nfs41 callbacks */
270 /* We currently support a single back channel with a single slot */
271 unsigned long cl_cb_slot_busy;
272 struct rpc_wait_queue cl_cb_waitq; /* backchannel callers may */
273 /* wait here for slots */
274};
275
276static inline void
277mark_client_expired(struct nfs4_client *clp)
278{
279 clp->cl_time = 0;
280}
281
282static inline bool
283is_client_expired(struct nfs4_client *clp)
284{
285 return clp->cl_time == 0;
286}
287
288/* struct nfs4_client_reset
289 * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
290 * upon lease reset, or from upcall to state_daemon (to read in state
291 * from non-volitile storage) upon reboot.
292 */
293struct nfs4_client_reclaim {
294 struct list_head cr_strhash; /* hash by cr_name */
295 char cr_recdir[HEXDIR_LEN]; /* recover dir */
296};
297
298static inline void
299update_stateid(stateid_t *stateid)
300{
301 stateid->si_generation++;
302 /* Wraparound recommendation from 3530bis-13 9.1.3.2: */
303 if (stateid->si_generation == 0)
304 stateid->si_generation = 1;
305}
306
307/* A reasonable value for REPLAY_ISIZE was estimated as follows:
308 * The OPEN response, typically the largest, requires
309 * 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) +
310 * 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
311 * 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
312 */
313
314#define NFSD4_REPLAY_ISIZE 112
315
316/*
317 * Replay buffer, where the result of the last seqid-mutating operation
318 * is cached.
319 */
320struct nfs4_replay {
321 __be32 rp_status;
322 unsigned int rp_buflen;
323 char *rp_buf;
324 struct knfsd_fh rp_openfh;
325 char rp_ibuf[NFSD4_REPLAY_ISIZE];
326};
327
328struct nfs4_stateowner {
329 struct list_head so_strhash; /* hash by op_name */
330 struct list_head so_stateids;
331 struct nfs4_client * so_client;
332 /* after increment in ENCODE_SEQID_OP_TAIL, represents the next
333 * sequence id expected from the client: */
334 u32 so_seqid;
335 struct xdr_netobj so_owner; /* open owner name */
336 struct nfs4_replay so_replay;
337 bool so_is_open_owner;
338};
339
340struct nfs4_openowner {
341 struct nfs4_stateowner oo_owner; /* must be first field */
342 struct list_head oo_perclient;
343 /*
344 * We keep around openowners a little while after last close,
345 * which saves clients from having to confirm, and allows us to
346 * handle close replays if they come soon enough. The close_lru
347 * is a list of such openowners, to be reaped by the laundromat
348 * thread eventually if they remain unused:
349 */
350 struct list_head oo_close_lru;
351 struct nfs4_ol_stateid *oo_last_closed_stid;
352 time_t oo_time; /* time of placement on so_close_lru */
353#define NFS4_OO_CONFIRMED 1
354#define NFS4_OO_PURGE_CLOSE 2
355#define NFS4_OO_NEW 4
356 unsigned char oo_flags;
357};
358
359struct nfs4_lockowner {
360 struct nfs4_stateowner lo_owner; /* must be first element */
361 struct list_head lo_owner_ino_hash; /* hash by owner,file */
362 struct list_head lo_perstateid; /* for lockowners only */
363 struct list_head lo_list; /* for temporary uses */
364};
365
366static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so)
367{
368 return container_of(so, struct nfs4_openowner, oo_owner);
369}
370
371static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so)
372{
373 return container_of(so, struct nfs4_lockowner, lo_owner);
374}
375
376/*
377* nfs4_file: a file opened by some number of (open) nfs4_stateowners.
378* o fi_perfile list is used to search for conflicting
379* share_acces, share_deny on the file.
380*/
381struct nfs4_file {
382 atomic_t fi_ref;
383 struct list_head fi_hash; /* hash by "struct inode *" */
384 struct list_head fi_stateids;
385 struct list_head fi_delegations;
386 /* One each for O_RDONLY, O_WRONLY, O_RDWR: */
387 struct file * fi_fds[3];
388 /*
389 * Each open or lock stateid contributes 0-4 to the counts
390 * below depending on which bits are set in st_access_bitmap:
391 * 1 to fi_access[O_RDONLY] if NFS4_SHARE_ACCES_READ is set
392 * + 1 to fi_access[O_WRONLY] if NFS4_SHARE_ACCESS_WRITE is set
393 * + 1 to both of the above if NFS4_SHARE_ACCESS_BOTH is set.
394 */
395 atomic_t fi_access[2];
396 struct file *fi_deleg_file;
397 struct file_lock *fi_lease;
398 atomic_t fi_delegees;
399 struct inode *fi_inode;
400 bool fi_had_conflict;
401};
402
403/* XXX: for first cut may fall back on returning file that doesn't work
404 * at all? */
405static inline struct file *find_writeable_file(struct nfs4_file *f)
406{
407 if (f->fi_fds[O_WRONLY])
408 return f->fi_fds[O_WRONLY];
409 return f->fi_fds[O_RDWR];
410}
411
412static inline struct file *find_readable_file(struct nfs4_file *f)
413{
414 if (f->fi_fds[O_RDONLY])
415 return f->fi_fds[O_RDONLY];
416 return f->fi_fds[O_RDWR];
417}
418
419static inline struct file *find_any_file(struct nfs4_file *f)
420{
421 if (f->fi_fds[O_RDWR])
422 return f->fi_fds[O_RDWR];
423 else if (f->fi_fds[O_WRONLY])
424 return f->fi_fds[O_WRONLY];
425 else
426 return f->fi_fds[O_RDONLY];
427}
428
429/* "ol" stands for "Open or Lock". Better suggestions welcome. */
430struct nfs4_ol_stateid {
431 struct nfs4_stid st_stid; /* must be first field */
432 struct list_head st_perfile;
433 struct list_head st_perstateowner;
434 struct list_head st_lockowners;
435 struct nfs4_stateowner * st_stateowner;
436 struct nfs4_file * st_file;
437 unsigned long st_access_bmap;
438 unsigned long st_deny_bmap;
439 struct nfs4_ol_stateid * st_openstp;
440};
441
442static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s)
443{
444 return container_of(s, struct nfs4_ol_stateid, st_stid);
445}
446
447/* flags for preprocess_seqid_op() */
448#define RD_STATE 0x00000010
449#define WR_STATE 0x00000020
450
451struct nfsd4_compound_state;
452
453extern __be32 nfs4_preprocess_stateid_op(struct nfsd4_compound_state *cstate,
454 stateid_t *stateid, int flags, struct file **filp);
455extern void nfs4_lock_state(void);
456extern void nfs4_unlock_state(void);
457extern int nfs4_in_grace(void);
458extern void nfs4_release_reclaim(void);
459extern struct nfs4_client_reclaim *nfsd4_find_reclaim_client(struct nfs4_client *crp);
460extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
461extern void nfs4_free_openowner(struct nfs4_openowner *);
462extern void nfs4_free_lockowner(struct nfs4_lockowner *);
463extern int set_callback_cred(void);
464extern void nfsd4_probe_callback(struct nfs4_client *clp);
465extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
466extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
467extern void nfsd4_do_callback_rpc(struct work_struct *);
468extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
469extern int nfsd4_create_callback_queue(void);
470extern void nfsd4_destroy_callback_queue(void);
471extern void nfsd4_shutdown_callback(struct nfs4_client *);
472extern void nfs4_put_delegation(struct nfs4_delegation *dp);
473extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
474extern int nfs4_client_to_reclaim(const char *name);
475extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
476extern void release_session_client(struct nfsd4_session *);
477extern __be32 nfs4_validate_stateid(struct nfs4_client *, stateid_t *);
478extern void nfsd4_purge_closed_stateid(struct nfs4_stateowner *);
479
480/* nfs4recover operations */
481extern int nfsd4_client_tracking_init(struct net *net);
482extern void nfsd4_client_tracking_exit(struct net *net);
483extern void nfsd4_client_record_create(struct nfs4_client *clp);
484extern void nfsd4_client_record_remove(struct nfs4_client *clp);
485extern int nfsd4_client_record_check(struct nfs4_client *clp);
486extern void nfsd4_record_grace_done(struct net *net, time_t boot_time);
487#endif /* NFSD4_STATE_H */