Merge tag 'jfs-3.10' of git://github.com/kleikamp/linux-shaggy
[linux-3.10.git] / fs / nfsd / 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
43 typedef struct {
44         u32             cl_boot;
45         u32             cl_id;
46 } clientid_t;
47
48 typedef struct {
49         clientid_t      so_clid;
50         u32             so_id;
51 } stateid_opaque_t;
52
53 typedef 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
65 struct 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
76 struct 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
87 struct 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 */
103 struct 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
114 static 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
130 struct 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
142 struct 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
153 struct nfsd4_cb_sec {
154         u32     flavor; /* (u32)(-1) used to mean "no valid flavor" */
155         kuid_t  uid;
156         kgid_t  gid;
157 };
158
159 struct nfsd4_create_session {
160         clientid_t                      clientid;
161         struct nfs4_sessionid           sessionid;
162         u32                             seqid;
163         u32                             flags;
164         struct nfsd4_channel_attrs      fore_channel;
165         struct nfsd4_channel_attrs      back_channel;
166         u32                             callback_prog;
167         struct nfsd4_cb_sec             cb_sec;
168 };
169
170 struct nfsd4_backchannel_ctl {
171         u32     bc_cb_program;
172         struct nfsd4_cb_sec             bc_cb_sec;
173 };
174
175 struct nfsd4_bind_conn_to_session {
176         struct nfs4_sessionid           sessionid;
177         u32                             dir;
178 };
179
180 /* The single slot clientid cache structure */
181 struct nfsd4_clid_slot {
182         u32                             sl_seqid;
183         __be32                          sl_status;
184         struct nfsd4_create_session     sl_cr_ses;
185 };
186
187 struct nfsd4_conn {
188         struct list_head cn_persession;
189         struct svc_xprt *cn_xprt;
190         struct svc_xpt_user cn_xpt_user;
191         struct nfsd4_session *cn_session;
192 /* CDFC4_FORE, CDFC4_BACK: */
193         unsigned char cn_flags;
194 };
195
196 struct nfsd4_session {
197         struct kref             se_ref;
198         struct list_head        se_hash;        /* hash by sessionid */
199         struct list_head        se_perclnt;
200         u32                     se_flags;
201         struct nfs4_client      *se_client;
202         struct nfs4_sessionid   se_sessionid;
203         struct nfsd4_channel_attrs se_fchannel;
204         struct nfsd4_channel_attrs se_bchannel;
205         struct nfsd4_cb_sec     se_cb_sec;
206         struct list_head        se_conns;
207         u32                     se_cb_prog;
208         u32                     se_cb_seq_nr;
209         struct nfsd4_slot       *se_slots[];    /* forward channel slots */
210 };
211
212 extern void nfsd4_put_session(struct nfsd4_session *ses);
213
214 /* formatted contents of nfs4_sessionid */
215 struct nfsd4_sessionid {
216         clientid_t      clientid;
217         u32             sequence;
218         u32             reserved;
219 };
220
221 #define HEXDIR_LEN     33 /* hex version of 16 byte md5 of cl_name plus '\0' */
222
223 /*
224  * struct nfs4_client - one per client.  Clientids live here.
225  *      o Each nfs4_client is hashed by clientid.
226  *
227  *      o Each nfs4_clients is also hashed by name 
228  *        (the opaque quantity initially sent by the client to identify itself).
229  *        
230  *      o cl_perclient list is used to ensure no dangling stateowner references
231  *        when we expire the nfs4_client
232  */
233 struct nfs4_client {
234         struct list_head        cl_idhash;      /* hash by cl_clientid.id */
235         struct rb_node          cl_namenode;    /* link into by-name trees */
236         struct list_head        cl_openowners;
237         struct idr              cl_stateids;    /* stateid lookup */
238         struct list_head        cl_delegations;
239         struct list_head        cl_lru;         /* tail queue */
240         struct xdr_netobj       cl_name;        /* id generated by client */
241         nfs4_verifier           cl_verifier;    /* generated by client */
242         time_t                  cl_time;        /* time of last lease renewal */
243         struct sockaddr_storage cl_addr;        /* client ipaddress */
244         struct svc_cred         cl_cred;        /* setclientid principal */
245         clientid_t              cl_clientid;    /* generated by server */
246         nfs4_verifier           cl_confirm;     /* generated by server */
247         u32                     cl_minorversion;
248
249         /* for v4.0 and v4.1 callbacks: */
250         struct nfs4_cb_conn     cl_cb_conn;
251 #define NFSD4_CLIENT_CB_UPDATE          (0)
252 #define NFSD4_CLIENT_CB_KILL            (1)
253 #define NFSD4_CLIENT_STABLE             (2)     /* client on stable storage */
254 #define NFSD4_CLIENT_RECLAIM_COMPLETE   (3)     /* reclaim_complete done */
255 #define NFSD4_CLIENT_CONFIRMED          (4)     /* client is confirmed */
256 #define NFSD4_CLIENT_CB_FLAG_MASK       (1 << NFSD4_CLIENT_CB_UPDATE | \
257                                          1 << NFSD4_CLIENT_CB_KILL)
258         unsigned long           cl_flags;
259         struct rpc_cred         *cl_cb_cred;
260         struct rpc_clnt         *cl_cb_client;
261         u32                     cl_cb_ident;
262 #define NFSD4_CB_UP             0
263 #define NFSD4_CB_UNKNOWN        1
264 #define NFSD4_CB_DOWN           2
265 #define NFSD4_CB_FAULT          3
266         int                     cl_cb_state;
267         struct nfsd4_callback   cl_cb_null;
268         struct nfsd4_session    *cl_cb_session;
269         struct list_head        cl_callbacks; /* list of in-progress callbacks */
270
271         /* for all client information that callback code might need: */
272         spinlock_t              cl_lock;
273
274         /* for nfs41 */
275         struct list_head        cl_sessions;
276         struct nfsd4_clid_slot  cl_cs_slot;     /* create_session slot */
277         u32                     cl_exchange_flags;
278         /* number of rpc's in progress over an associated session: */
279         atomic_t                cl_refcount;
280
281         /* for nfs41 callbacks */
282         /* We currently support a single back channel with a single slot */
283         unsigned long           cl_cb_slot_busy;
284         struct rpc_wait_queue   cl_cb_waitq;    /* backchannel callers may */
285                                                 /* wait here for slots */
286         struct net              *net;
287 };
288
289 static inline void
290 mark_client_expired(struct nfs4_client *clp)
291 {
292         clp->cl_time = 0;
293 }
294
295 static inline bool
296 is_client_expired(struct nfs4_client *clp)
297 {
298         return clp->cl_time == 0;
299 }
300
301 /* struct nfs4_client_reset
302  * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
303  * upon lease reset, or from upcall to state_daemon (to read in state
304  * from non-volitile storage) upon reboot.
305  */
306 struct nfs4_client_reclaim {
307         struct list_head        cr_strhash;     /* hash by cr_name */
308         struct nfs4_client      *cr_clp;        /* pointer to associated clp */
309         char                    cr_recdir[HEXDIR_LEN]; /* recover dir */
310 };
311
312 static inline void
313 update_stateid(stateid_t *stateid)
314 {
315         stateid->si_generation++;
316         /* Wraparound recommendation from 3530bis-13 9.1.3.2: */
317         if (stateid->si_generation == 0)
318                 stateid->si_generation = 1;
319 }
320
321 /* A reasonable value for REPLAY_ISIZE was estimated as follows:  
322  * The OPEN response, typically the largest, requires 
323  *   4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) +  8(verifier) + 
324  *   4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) + 
325  *   20(deleg. space limit) + ~32(deleg. ace) = 112 bytes 
326  */
327
328 #define NFSD4_REPLAY_ISIZE       112 
329
330 /*
331  * Replay buffer, where the result of the last seqid-mutating operation 
332  * is cached. 
333  */
334 struct nfs4_replay {
335         __be32                  rp_status;
336         unsigned int            rp_buflen;
337         char                    *rp_buf;
338         struct knfsd_fh         rp_openfh;
339         char                    rp_ibuf[NFSD4_REPLAY_ISIZE];
340 };
341
342 struct nfs4_stateowner {
343         struct list_head        so_strhash;   /* hash by op_name */
344         struct list_head        so_stateids;
345         struct nfs4_client *    so_client;
346         /* after increment in ENCODE_SEQID_OP_TAIL, represents the next
347          * sequence id expected from the client: */
348         u32                     so_seqid;
349         struct xdr_netobj       so_owner;     /* open owner name */
350         struct nfs4_replay      so_replay;
351         bool                    so_is_open_owner;
352 };
353
354 struct nfs4_openowner {
355         struct nfs4_stateowner  oo_owner; /* must be first field */
356         struct list_head        oo_perclient;
357         /*
358          * We keep around openowners a little while after last close,
359          * which saves clients from having to confirm, and allows us to
360          * handle close replays if they come soon enough.  The close_lru
361          * is a list of such openowners, to be reaped by the laundromat
362          * thread eventually if they remain unused:
363          */
364         struct list_head        oo_close_lru;
365         struct nfs4_ol_stateid *oo_last_closed_stid;
366         time_t                  oo_time; /* time of placement on so_close_lru */
367 #define NFS4_OO_CONFIRMED   1
368 #define NFS4_OO_PURGE_CLOSE 2
369 #define NFS4_OO_NEW         4
370         unsigned char           oo_flags;
371 };
372
373 struct nfs4_lockowner {
374         struct nfs4_stateowner  lo_owner; /* must be first element */
375         struct list_head        lo_owner_ino_hash; /* hash by owner,file */
376         struct list_head        lo_perstateid; /* for lockowners only */
377         struct list_head        lo_list; /* for temporary uses */
378 };
379
380 static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so)
381 {
382         return container_of(so, struct nfs4_openowner, oo_owner);
383 }
384
385 static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so)
386 {
387         return container_of(so, struct nfs4_lockowner, lo_owner);
388 }
389
390 /* nfs4_file: a file opened by some number of (open) nfs4_stateowners. */
391 struct nfs4_file {
392         atomic_t                fi_ref;
393         struct list_head        fi_hash;    /* hash by "struct inode *" */
394         struct list_head        fi_stateids;
395         struct list_head        fi_delegations;
396         /* One each for O_RDONLY, O_WRONLY, O_RDWR: */
397         struct file *           fi_fds[3];
398         /*
399          * Each open or lock stateid contributes 0-4 to the counts
400          * below depending on which bits are set in st_access_bitmap:
401          *     1 to fi_access[O_RDONLY] if NFS4_SHARE_ACCES_READ is set
402          *   + 1 to fi_access[O_WRONLY] if NFS4_SHARE_ACCESS_WRITE is set
403          *   + 1 to both of the above if NFS4_SHARE_ACCESS_BOTH is set.
404          */
405         atomic_t                fi_access[2];
406         struct file             *fi_deleg_file;
407         struct file_lock        *fi_lease;
408         atomic_t                fi_delegees;
409         struct inode            *fi_inode;
410         bool                    fi_had_conflict;
411 };
412
413 /* XXX: for first cut may fall back on returning file that doesn't work
414  * at all? */
415 static inline struct file *find_writeable_file(struct nfs4_file *f)
416 {
417         if (f->fi_fds[O_WRONLY])
418                 return f->fi_fds[O_WRONLY];
419         return f->fi_fds[O_RDWR];
420 }
421
422 static inline struct file *find_readable_file(struct nfs4_file *f)
423 {
424         if (f->fi_fds[O_RDONLY])
425                 return f->fi_fds[O_RDONLY];
426         return f->fi_fds[O_RDWR];
427 }
428
429 static inline struct file *find_any_file(struct nfs4_file *f)
430 {
431         if (f->fi_fds[O_RDWR])
432                 return f->fi_fds[O_RDWR];
433         else if (f->fi_fds[O_WRONLY])
434                 return f->fi_fds[O_WRONLY];
435         else
436                 return f->fi_fds[O_RDONLY];
437 }
438
439 /* "ol" stands for "Open or Lock".  Better suggestions welcome. */
440 struct nfs4_ol_stateid {
441         struct nfs4_stid    st_stid; /* must be first field */
442         struct list_head              st_perfile;
443         struct list_head              st_perstateowner;
444         struct list_head              st_lockowners;
445         struct nfs4_stateowner      * st_stateowner;
446         struct nfs4_file            * st_file;
447         unsigned long                 st_access_bmap;
448         unsigned long                 st_deny_bmap;
449         struct nfs4_ol_stateid         * st_openstp;
450 };
451
452 static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s)
453 {
454         return container_of(s, struct nfs4_ol_stateid, st_stid);
455 }
456
457 /* flags for preprocess_seqid_op() */
458 #define RD_STATE                0x00000010
459 #define WR_STATE                0x00000020
460
461 struct nfsd4_compound_state;
462 struct nfsd_net;
463
464 extern __be32 nfs4_preprocess_stateid_op(struct net *net,
465                 struct nfsd4_compound_state *cstate,
466                 stateid_t *stateid, int flags, struct file **filp);
467 extern void nfs4_lock_state(void);
468 extern void nfs4_unlock_state(void);
469 void nfs4_remove_reclaim_record(struct nfs4_client_reclaim *, struct nfsd_net *);
470 extern void nfs4_release_reclaim(struct nfsd_net *);
471 extern struct nfs4_client_reclaim *nfsd4_find_reclaim_client(const char *recdir,
472                                                         struct nfsd_net *nn);
473 extern __be32 nfs4_check_open_reclaim(clientid_t *clid, bool sessions, struct nfsd_net *nn);
474 extern void nfs4_free_openowner(struct nfs4_openowner *);
475 extern void nfs4_free_lockowner(struct nfs4_lockowner *);
476 extern int set_callback_cred(void);
477 extern void nfsd4_init_callback(struct nfsd4_callback *);
478 extern void nfsd4_probe_callback(struct nfs4_client *clp);
479 extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
480 extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
481 extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
482 extern int nfsd4_create_callback_queue(void);
483 extern void nfsd4_destroy_callback_queue(void);
484 extern void nfsd4_shutdown_callback(struct nfs4_client *);
485 extern void nfs4_put_delegation(struct nfs4_delegation *dp);
486 extern struct nfs4_client_reclaim *nfs4_client_to_reclaim(const char *name,
487                                                         struct nfsd_net *nn);
488 extern bool nfs4_has_reclaimed_state(const char *name, struct nfsd_net *nn);
489 extern void release_session_client(struct nfsd4_session *);
490 extern void nfsd4_purge_closed_stateid(struct nfs4_stateowner *);
491
492 /* nfs4recover operations */
493 extern int nfsd4_client_tracking_init(struct net *net);
494 extern void nfsd4_client_tracking_exit(struct net *net);
495 extern void nfsd4_client_record_create(struct nfs4_client *clp);
496 extern void nfsd4_client_record_remove(struct nfs4_client *clp);
497 extern int nfsd4_client_record_check(struct nfs4_client *clp);
498 extern void nfsd4_record_grace_done(struct nfsd_net *nn, time_t boot_time);
499
500 /* nfs fault injection functions */
501 #ifdef CONFIG_NFSD_FAULT_INJECTION
502 int nfsd_fault_inject_init(void);
503 void nfsd_fault_inject_cleanup(void);
504 u64 nfsd_for_n_state(u64, u64 (*)(struct nfs4_client *, u64));
505 struct nfs4_client *nfsd_find_client(struct sockaddr_storage *, size_t);
506
507 u64 nfsd_forget_client(struct nfs4_client *, u64);
508 u64 nfsd_forget_client_locks(struct nfs4_client*, u64);
509 u64 nfsd_forget_client_openowners(struct nfs4_client *, u64);
510 u64 nfsd_forget_client_delegations(struct nfs4_client *, u64);
511 u64 nfsd_recall_client_delegations(struct nfs4_client *, u64);
512
513 u64 nfsd_print_client(struct nfs4_client *, u64);
514 u64 nfsd_print_client_locks(struct nfs4_client *, u64);
515 u64 nfsd_print_client_openowners(struct nfs4_client *, u64);
516 u64 nfsd_print_client_delegations(struct nfs4_client *, u64);
517 #else /* CONFIG_NFSD_FAULT_INJECTION */
518 static inline int nfsd_fault_inject_init(void) { return 0; }
519 static inline void nfsd_fault_inject_cleanup(void) {}
520 #endif /* CONFIG_NFSD_FAULT_INJECTION */
521
522 #endif   /* NFSD4_STATE_H */