Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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 | |
J. Bruce Fields | 38c2f4b | 2011-09-23 17:01:19 -0400 | [diff] [blame] | 38 | #include <linux/idr.h> |
J. Bruce Fields | 19cf5c0 | 2010-06-06 18:37:16 -0400 | [diff] [blame] | 39 | #include <linux/sunrpc/svc_xprt.h> |
Boaz Harrosh | 72579ac | 2009-12-03 20:28:59 +0200 | [diff] [blame] | 40 | #include <linux/nfsd/nfsfh.h> |
J. Bruce Fields | 1557aca | 2009-12-04 19:36:06 -0500 | [diff] [blame] | 41 | #include "nfsfh.h" |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 42 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 43 | typedef struct { |
| 44 | u32 cl_boot; |
| 45 | u32 cl_id; |
| 46 | } clientid_t; |
| 47 | |
| 48 | typedef struct { |
J. Bruce Fields | d3b313a | 2011-09-15 15:02:41 -0400 | [diff] [blame] | 49 | clientid_t so_clid; |
| 50 | u32 so_id; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 51 | } stateid_opaque_t; |
| 52 | |
| 53 | typedef struct { |
| 54 | u32 si_generation; |
| 55 | stateid_opaque_t si_opaque; |
| 56 | } stateid_t; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 57 | |
Benny Halevy | 8c10cbd | 2009-10-19 12:04:53 +0200 | [diff] [blame] | 58 | #define STATEID_FMT "(%08x/%08x/%08x/%08x)" |
| 59 | #define STATEID_VAL(s) \ |
J. Bruce Fields | d3b313a | 2011-09-15 15:02:41 -0400 | [diff] [blame] | 60 | (s)->si_opaque.so_clid.cl_boot, \ |
| 61 | (s)->si_opaque.so_clid.cl_id, \ |
| 62 | (s)->si_opaque.so_id, \ |
Benny Halevy | 8c10cbd | 2009-10-19 12:04:53 +0200 | [diff] [blame] | 63 | (s)->si_generation |
| 64 | |
J. Bruce Fields | 227f98d9 | 2010-02-18 08:27:24 -0800 | [diff] [blame] | 65 | struct nfsd4_callback { |
J. Bruce Fields | fb00392 | 2010-05-31 18:21:37 -0400 | [diff] [blame] | 66 | void *cb_op; |
| 67 | struct nfs4_client *cb_clp; |
J. Bruce Fields | 5ce8ba2 | 2011-01-10 16:44:41 -0500 | [diff] [blame] | 68 | struct list_head cb_per_client; |
J. Bruce Fields | fb00392 | 2010-05-31 18:21:37 -0400 | [diff] [blame] | 69 | u32 cb_minorversion; |
J. Bruce Fields | 5878453 | 2010-05-16 16:47:08 -0400 | [diff] [blame] | 70 | struct rpc_message cb_msg; |
| 71 | const struct rpc_call_ops *cb_ops; |
J. Bruce Fields | b5a1a81 | 2010-03-03 14:52:55 -0500 | [diff] [blame] | 72 | struct work_struct cb_work; |
J. Bruce Fields | 5ce8ba2 | 2011-01-10 16:44:41 -0500 | [diff] [blame] | 73 | bool cb_done; |
J. Bruce Fields | 227f98d9 | 2010-02-18 08:27:24 -0800 | [diff] [blame] | 74 | }; |
| 75 | |
J. Bruce Fields | d5477a8 | 2011-09-08 12:07:44 -0400 | [diff] [blame] | 76 | struct nfs4_stid { |
| 77 | #define NFS4_OPEN_STID 1 |
| 78 | #define NFS4_LOCK_STID 2 |
| 79 | #define NFS4_DELEG_STID 4 |
J. Bruce Fields | f7a4d87 | 2011-09-16 20:12:38 -0400 | [diff] [blame] | 80 | /* For an open stateid kept around *only* to process close replays: */ |
| 81 | #define NFS4_CLOSED_STID 8 |
| 82 | unsigned char sc_type; |
J. Bruce Fields | d5477a8 | 2011-09-08 12:07:44 -0400 | [diff] [blame] | 83 | stateid_t sc_stateid; |
J. Bruce Fields | 2a74aba | 2011-09-23 17:20:02 -0400 | [diff] [blame] | 84 | struct nfs4_client *sc_client; |
J. Bruce Fields | d5477a8 | 2011-09-08 12:07:44 -0400 | [diff] [blame] | 85 | }; |
| 86 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 87 | struct nfs4_delegation { |
NeilBrown | ea1da63 | 2005-06-23 22:04:17 -0700 | [diff] [blame] | 88 | struct list_head dl_perfile; |
| 89 | struct list_head dl_perclnt; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 90 | struct list_head dl_recall_lru; /* delegation recalled */ |
| 91 | atomic_t dl_count; /* ref count */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 92 | struct nfs4_file *dl_file; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 93 | u32 dl_type; |
| 94 | time_t dl_time; |
J. Bruce Fields | b53d40c | 2009-05-01 19:50:00 -0400 | [diff] [blame] | 95 | /* For recall: */ |
J. Bruce Fields | d5477a8 | 2011-09-08 12:07:44 -0400 | [diff] [blame] | 96 | struct nfs4_stid dl_stid; |
J. Bruce Fields | b53d40c | 2009-05-01 19:50:00 -0400 | [diff] [blame] | 97 | struct knfsd_fh dl_fh; |
J. Bruce Fields | 3aea09d | 2009-05-01 20:11:12 -0400 | [diff] [blame] | 98 | int dl_retries; |
J. Bruce Fields | 227f98d9 | 2010-02-18 08:27:24 -0800 | [diff] [blame] | 99 | struct nfsd4_callback dl_recall; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 100 | }; |
| 101 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 102 | /* client delegation callback info */ |
J. Bruce Fields | c237dc0 | 2009-04-29 19:09:19 -0400 | [diff] [blame] | 103 | struct nfs4_cb_conn { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 104 | /* SETCLIENTID info */ |
Jeff Layton | aa9a4ec | 2009-08-14 12:57:57 -0400 | [diff] [blame] | 105 | struct sockaddr_storage cb_addr; |
Takuma Umeya | 6f3d772 | 2010-12-15 14:09:01 +0900 | [diff] [blame] | 106 | struct sockaddr_storage cb_saddr; |
Jeff Layton | aa9a4ec | 2009-08-14 12:57:57 -0400 | [diff] [blame] | 107 | size_t cb_addrlen; |
J. Bruce Fields | 8b5ce5c | 2010-10-19 17:31:50 -0400 | [diff] [blame] | 108 | u32 cb_prog; /* used only in 4.0 case; |
| 109 | per-session otherwise */ |
Andy Adamson | ab52ae6 | 2009-06-16 04:20:53 +0300 | [diff] [blame] | 110 | u32 cb_ident; /* minorversion 0 only */ |
J. Bruce Fields | 2bf2387 | 2010-03-08 12:37:27 -0500 | [diff] [blame] | 111 | struct svc_xprt *cb_xprt; /* minorversion 1 only */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 112 | }; |
| 113 | |
J. Bruce Fields | f459e45 | 2011-09-09 09:06:12 -0400 | [diff] [blame] | 114 | static inline struct nfs4_delegation *delegstateid(struct nfs4_stid *s) |
| 115 | { |
| 116 | return container_of(s, struct nfs4_delegation, dl_stid); |
| 117 | } |
| 118 | |
Andy Adamson | a649637 | 2009-08-28 08:45:01 -0400 | [diff] [blame] | 119 | /* Maximum number of slots per session. 160 is useful for long haul TCP */ |
| 120 | #define NFSD_MAX_SLOTS_PER_SESSION 160 |
Andy Adamson | ec6b5d7 | 2009-04-03 08:28:28 +0300 | [diff] [blame] | 121 | /* Maximum number of operations per session compound */ |
| 122 | #define NFSD_MAX_OPS_PER_COMPOUND 16 |
Andy Adamson | 557ce26 | 2009-08-28 08:45:04 -0400 | [diff] [blame] | 123 | /* Maximum session per slot cache size */ |
| 124 | #define NFSD_SLOT_CACHE_SIZE 1024 |
Andy Adamson | a649637 | 2009-08-28 08:45:01 -0400 | [diff] [blame] | 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) |
Andy Adamson | 074fe89 | 2009-04-03 08:28:15 +0300 | [diff] [blame] | 129 | |
Andy Adamson | 7116ed6 | 2009-04-03 08:27:43 +0300 | [diff] [blame] | 130 | struct nfsd4_slot { |
Andy Adamson | 557ce26 | 2009-08-28 08:45:04 -0400 | [diff] [blame] | 131 | bool sl_inuse; |
| 132 | bool sl_cachethis; |
| 133 | u16 sl_opcnt; |
| 134 | u32 sl_seqid; |
| 135 | __be32 sl_status; |
| 136 | u32 sl_datalen; |
| 137 | char sl_data[]; |
Andy Adamson | 7116ed6 | 2009-04-03 08:27:43 +0300 | [diff] [blame] | 138 | }; |
| 139 | |
Alexandros Batsakis | 6c18ba9 | 2009-06-16 04:19:13 +0300 | [diff] [blame] | 140 | struct nfsd4_channel_attrs { |
| 141 | u32 headerpadsz; |
| 142 | u32 maxreq_sz; |
| 143 | u32 maxresp_sz; |
| 144 | u32 maxresp_cached; |
| 145 | u32 maxops; |
| 146 | u32 maxreqs; |
| 147 | u32 nr_rdma_attrs; |
| 148 | u32 rdma_attrs; |
| 149 | }; |
| 150 | |
Andy Adamson | 49557cc | 2009-07-23 19:02:16 -0400 | [diff] [blame] | 151 | struct nfsd4_create_session { |
| 152 | clientid_t clientid; |
| 153 | struct nfs4_sessionid sessionid; |
| 154 | u32 seqid; |
| 155 | u32 flags; |
| 156 | struct nfsd4_channel_attrs fore_channel; |
| 157 | struct nfsd4_channel_attrs back_channel; |
| 158 | u32 callback_prog; |
| 159 | u32 uid; |
| 160 | u32 gid; |
| 161 | }; |
| 162 | |
J. Bruce Fields | 1d1bc8f | 2010-10-04 23:12:59 -0400 | [diff] [blame] | 163 | struct nfsd4_bind_conn_to_session { |
| 164 | struct nfs4_sessionid sessionid; |
| 165 | u32 dir; |
| 166 | }; |
| 167 | |
Andy Adamson | 49557cc | 2009-07-23 19:02:16 -0400 | [diff] [blame] | 168 | /* The single slot clientid cache structure */ |
| 169 | struct nfsd4_clid_slot { |
| 170 | u32 sl_seqid; |
| 171 | __be32 sl_status; |
| 172 | struct nfsd4_create_session sl_cr_ses; |
| 173 | }; |
| 174 | |
J. Bruce Fields | c766251 | 2010-06-06 18:12:14 -0400 | [diff] [blame] | 175 | struct nfsd4_conn { |
| 176 | struct list_head cn_persession; |
| 177 | struct svc_xprt *cn_xprt; |
J. Bruce Fields | 19cf5c0 | 2010-06-06 18:37:16 -0400 | [diff] [blame] | 178 | struct svc_xpt_user cn_xpt_user; |
| 179 | struct nfsd4_session *cn_session; |
J. Bruce Fields | c766251 | 2010-06-06 18:12:14 -0400 | [diff] [blame] | 180 | /* CDFC4_FORE, CDFC4_BACK: */ |
| 181 | unsigned char cn_flags; |
| 182 | }; |
| 183 | |
Andy Adamson | 7116ed6 | 2009-04-03 08:27:43 +0300 | [diff] [blame] | 184 | struct nfsd4_session { |
| 185 | struct kref se_ref; |
| 186 | struct list_head se_hash; /* hash by sessionid */ |
| 187 | struct list_head se_perclnt; |
| 188 | u32 se_flags; |
Benny Halevy | 07cd490 | 2010-05-12 00:13:41 +0300 | [diff] [blame] | 189 | struct nfs4_client *se_client; |
Andy Adamson | 7116ed6 | 2009-04-03 08:27:43 +0300 | [diff] [blame] | 190 | struct nfs4_sessionid se_sessionid; |
Alexandros Batsakis | 6c18ba9 | 2009-06-16 04:19:13 +0300 | [diff] [blame] | 191 | struct nfsd4_channel_attrs se_fchannel; |
| 192 | struct nfsd4_channel_attrs se_bchannel; |
J. Bruce Fields | c766251 | 2010-06-06 18:12:14 -0400 | [diff] [blame] | 193 | struct list_head se_conns; |
J. Bruce Fields | 8b5ce5c | 2010-10-19 17:31:50 -0400 | [diff] [blame] | 194 | u32 se_cb_prog; |
J. Bruce Fields | ac7c46f | 2010-06-14 19:01:57 -0400 | [diff] [blame] | 195 | u32 se_cb_seq_nr; |
Andy Adamson | 557ce26 | 2009-08-28 08:45:04 -0400 | [diff] [blame] | 196 | struct nfsd4_slot *se_slots[]; /* forward channel slots */ |
Andy Adamson | 7116ed6 | 2009-04-03 08:27:43 +0300 | [diff] [blame] | 197 | }; |
| 198 | |
| 199 | static inline void |
| 200 | nfsd4_put_session(struct nfsd4_session *ses) |
| 201 | { |
| 202 | extern void free_session(struct kref *kref); |
| 203 | kref_put(&ses->se_ref, free_session); |
| 204 | } |
| 205 | |
| 206 | static inline void |
| 207 | nfsd4_get_session(struct nfsd4_session *ses) |
| 208 | { |
| 209 | kref_get(&ses->se_ref); |
| 210 | } |
| 211 | |
Marc Eshel | 5282fd7 | 2009-04-03 08:27:52 +0300 | [diff] [blame] | 212 | /* formatted contents of nfs4_sessionid */ |
| 213 | struct nfsd4_sessionid { |
| 214 | clientid_t clientid; |
| 215 | u32 sequence; |
| 216 | u32 reserved; |
| 217 | }; |
| 218 | |
NeilBrown | a55370a | 2005-06-23 22:03:52 -0700 | [diff] [blame] | 219 | #define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */ |
| 220 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 221 | /* |
| 222 | * struct nfs4_client - one per client. Clientids live here. |
| 223 | * o Each nfs4_client is hashed by clientid. |
| 224 | * |
| 225 | * o Each nfs4_clients is also hashed by name |
| 226 | * (the opaque quantity initially sent by the client to identify itself). |
| 227 | * |
| 228 | * o cl_perclient list is used to ensure no dangling stateowner references |
| 229 | * when we expire the nfs4_client |
| 230 | */ |
| 231 | struct nfs4_client { |
| 232 | struct list_head cl_idhash; /* hash by cl_clientid.id */ |
| 233 | struct list_head cl_strhash; /* hash by cl_name */ |
NeilBrown | ea1da63 | 2005-06-23 22:04:17 -0700 | [diff] [blame] | 234 | struct list_head cl_openowners; |
J. Bruce Fields | 38c2f4b | 2011-09-23 17:01:19 -0400 | [diff] [blame] | 235 | struct idr cl_stateids; /* stateid lookup */ |
NeilBrown | ea1da63 | 2005-06-23 22:04:17 -0700 | [diff] [blame] | 236 | struct list_head cl_delegations; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 237 | struct list_head cl_lru; /* tail queue */ |
| 238 | struct xdr_netobj cl_name; /* id generated by client */ |
NeilBrown | a55370a | 2005-06-23 22:03:52 -0700 | [diff] [blame] | 239 | char cl_recdir[HEXDIR_LEN]; /* recovery dir */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 240 | nfs4_verifier cl_verifier; /* generated by client */ |
| 241 | time_t cl_time; /* time of last lease renewal */ |
Jeff Layton | 363168b | 2009-08-14 12:57:56 -0400 | [diff] [blame] | 242 | struct sockaddr_storage cl_addr; /* client ipaddress */ |
Olga Kornievskaia | 61054b1 | 2008-12-23 16:19:00 -0500 | [diff] [blame] | 243 | u32 cl_flavor; /* setclientid pseudoflavor */ |
Olga Kornievskaia | 68e76ad | 2008-12-23 16:17:15 -0500 | [diff] [blame] | 244 | char *cl_principal; /* setclientid principal name */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 245 | struct svc_cred cl_cred; /* setclientid principal */ |
| 246 | clientid_t cl_clientid; /* generated by server */ |
| 247 | nfs4_verifier cl_confirm; /* generated by server */ |
NeilBrown | c7b9a45 | 2005-06-23 22:04:30 -0700 | [diff] [blame] | 248 | u32 cl_firststate; /* recovery dir creation */ |
J. Bruce Fields | 8323c3b | 2010-10-19 19:36:51 -0400 | [diff] [blame] | 249 | u32 cl_minorversion; |
Marc Eshel | 9fb8707 | 2009-04-03 08:27:46 +0300 | [diff] [blame] | 250 | |
J. Bruce Fields | 2bf2387 | 2010-03-08 12:37:27 -0500 | [diff] [blame] | 251 | /* for v4.0 and v4.1 callbacks: */ |
| 252 | struct nfs4_cb_conn cl_cb_conn; |
J. Bruce Fields | 6ff8da0 | 2010-06-04 20:04:45 -0400 | [diff] [blame] | 253 | #define NFSD4_CLIENT_CB_UPDATE 1 |
| 254 | #define NFSD4_CLIENT_KILL 2 |
| 255 | unsigned long cl_cb_flags; |
J. Bruce Fields | 2bf2387 | 2010-03-08 12:37:27 -0500 | [diff] [blame] | 256 | struct rpc_clnt *cl_cb_client; |
J. Bruce Fields | 6ff8da0 | 2010-06-04 20:04:45 -0400 | [diff] [blame] | 257 | u32 cl_cb_ident; |
J. Bruce Fields | 77a3569 | 2010-04-30 18:51:44 -0400 | [diff] [blame] | 258 | #define NFSD4_CB_UP 0 |
| 259 | #define NFSD4_CB_UNKNOWN 1 |
| 260 | #define NFSD4_CB_DOWN 2 |
| 261 | int cl_cb_state; |
J. Bruce Fields | cee277d | 2010-05-26 17:52:14 -0400 | [diff] [blame] | 262 | struct nfsd4_callback cl_cb_null; |
J. Bruce Fields | edd7678 | 2010-06-14 22:26:31 -0400 | [diff] [blame] | 263 | struct nfsd4_session *cl_cb_session; |
J. Bruce Fields | 5ce8ba2 | 2011-01-10 16:44:41 -0500 | [diff] [blame] | 264 | struct list_head cl_callbacks; /* list of in-progress callbacks */ |
J. Bruce Fields | 2bf2387 | 2010-03-08 12:37:27 -0500 | [diff] [blame] | 265 | |
J. Bruce Fields | 6ff8da0 | 2010-06-04 20:04:45 -0400 | [diff] [blame] | 266 | /* for all client information that callback code might need: */ |
| 267 | spinlock_t cl_lock; |
| 268 | |
Marc Eshel | 9fb8707 | 2009-04-03 08:27:46 +0300 | [diff] [blame] | 269 | /* for nfs41 */ |
| 270 | struct list_head cl_sessions; |
Andy Adamson | 49557cc | 2009-07-23 19:02:16 -0400 | [diff] [blame] | 271 | struct nfsd4_clid_slot cl_cs_slot; /* create_session slot */ |
Andy Adamson | 0733d21 | 2009-04-03 08:28:01 +0300 | [diff] [blame] | 272 | u32 cl_exchange_flags; |
Benny Halevy | 46583e2 | 2010-05-12 00:13:29 +0300 | [diff] [blame] | 273 | /* number of rpc's in progress over an associated session: */ |
| 274 | atomic_t cl_refcount; |
Andy Adamson | 38524ab | 2009-09-10 12:25:59 +0300 | [diff] [blame] | 275 | |
| 276 | /* for nfs41 callbacks */ |
Ricardo Labiaga | 199ff35 | 2009-09-10 12:26:25 +0300 | [diff] [blame] | 277 | /* We currently support a single back channel with a single slot */ |
| 278 | unsigned long cl_cb_slot_busy; |
Ricardo Labiaga | 199ff35 | 2009-09-10 12:26:25 +0300 | [diff] [blame] | 279 | struct rpc_wait_queue cl_cb_waitq; /* backchannel callers may */ |
| 280 | /* wait here for slots */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 281 | }; |
| 282 | |
Benny Halevy | 07cd490 | 2010-05-12 00:13:41 +0300 | [diff] [blame] | 283 | static inline void |
| 284 | mark_client_expired(struct nfs4_client *clp) |
| 285 | { |
| 286 | clp->cl_time = 0; |
| 287 | } |
| 288 | |
| 289 | static inline bool |
| 290 | is_client_expired(struct nfs4_client *clp) |
| 291 | { |
| 292 | return clp->cl_time == 0; |
| 293 | } |
| 294 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 295 | /* struct nfs4_client_reset |
| 296 | * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl |
| 297 | * upon lease reset, or from upcall to state_daemon (to read in state |
| 298 | * from non-volitile storage) upon reboot. |
| 299 | */ |
| 300 | struct nfs4_client_reclaim { |
| 301 | struct list_head cr_strhash; /* hash by cr_name */ |
NeilBrown | a55370a | 2005-06-23 22:03:52 -0700 | [diff] [blame] | 302 | char cr_recdir[HEXDIR_LEN]; /* recover dir */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 303 | }; |
| 304 | |
| 305 | static inline void |
| 306 | update_stateid(stateid_t *stateid) |
| 307 | { |
| 308 | stateid->si_generation++; |
J. Bruce Fields | 81b8296 | 2011-08-23 11:03:29 -0400 | [diff] [blame] | 309 | /* Wraparound recommendation from 3530bis-13 9.1.3.2: */ |
| 310 | if (stateid->si_generation == 0) |
| 311 | stateid->si_generation = 1; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 312 | } |
| 313 | |
| 314 | /* A reasonable value for REPLAY_ISIZE was estimated as follows: |
| 315 | * The OPEN response, typically the largest, requires |
| 316 | * 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) + |
| 317 | * 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) + |
| 318 | * 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes |
| 319 | */ |
| 320 | |
| 321 | #define NFSD4_REPLAY_ISIZE 112 |
| 322 | |
| 323 | /* |
| 324 | * Replay buffer, where the result of the last seqid-mutating operation |
| 325 | * is cached. |
| 326 | */ |
| 327 | struct nfs4_replay { |
Al Viro | b37ad28 | 2006-10-19 23:28:59 -0700 | [diff] [blame] | 328 | __be32 rp_status; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 329 | unsigned int rp_buflen; |
| 330 | char *rp_buf; |
J. Bruce Fields | a4773c08 | 2009-02-02 17:23:10 -0500 | [diff] [blame] | 331 | struct knfsd_fh rp_openfh; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 332 | char rp_ibuf[NFSD4_REPLAY_ISIZE]; |
| 333 | }; |
| 334 | |
| 335 | /* |
| 336 | * nfs4_stateowner can either be an open_owner, or a lock_owner |
| 337 | * |
| 338 | * so_idhash: stateid_hashtbl[] for open owner, lockstateid_hashtbl[] |
| 339 | * for lock_owner |
| 340 | * so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[] |
| 341 | * for lock_owner |
| 342 | * so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client |
| 343 | * struct is reaped. |
J. Bruce Fields | dcef041 | 2011-09-07 16:06:42 -0400 | [diff] [blame] | 344 | * so_perfilestate: heads the list of nfs4_ol_stateid (either open or lock) |
| 345 | * and is used to ensure no dangling nfs4_ol_stateid references when we |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 346 | * release a stateowner. |
J. Bruce Fields | dcef041 | 2011-09-07 16:06:42 -0400 | [diff] [blame] | 347 | * so_perlockowner: (open) nfs4_ol_stateid->st_perlockowner entry - used when |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 348 | * close is called to reap associated byte-range locks |
| 349 | * so_close_lru: (open) stateowner is placed on this list instead of being |
| 350 | * reaped (when so_perfilestate is empty) to hold the last close replay. |
| 351 | * reaped by laundramat thread after lease period. |
| 352 | */ |
J. Bruce Fields | fe0750e | 2011-07-30 23:33:59 -0400 | [diff] [blame] | 353 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 354 | struct nfs4_stateowner { |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 355 | struct list_head so_strhash; /* hash by op_name */ |
NeilBrown | ea1da63 | 2005-06-23 22:04:17 -0700 | [diff] [blame] | 356 | struct list_head so_stateids; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 357 | int so_is_open_owner; /* 1=openowner,0=lockowner */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 358 | struct nfs4_client * so_client; |
NeilBrown | 7fb64ce | 2005-07-07 17:59:20 -0700 | [diff] [blame] | 359 | /* after increment in ENCODE_SEQID_OP_TAIL, represents the next |
| 360 | * sequence id expected from the client: */ |
| 361 | u32 so_seqid; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 362 | struct xdr_netobj so_owner; /* open owner name */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 363 | struct nfs4_replay so_replay; |
| 364 | }; |
| 365 | |
J. Bruce Fields | fe0750e | 2011-07-30 23:33:59 -0400 | [diff] [blame] | 366 | struct nfs4_openowner { |
| 367 | struct nfs4_stateowner oo_owner; /* must be first field */ |
| 368 | struct list_head oo_perclient; |
| 369 | struct list_head oo_close_lru; /* tail queue */ |
J. Bruce Fields | 38c387b | 2011-09-16 17:42:48 -0400 | [diff] [blame] | 370 | struct nfs4_ol_stateid *oo_last_closed_stid; |
J. Bruce Fields | fe0750e | 2011-07-30 23:33:59 -0400 | [diff] [blame] | 371 | time_t oo_time; /* time of placement on so_close_lru */ |
J. Bruce Fields | dad1c06 | 2011-09-12 12:24:13 -0400 | [diff] [blame] | 372 | #define NFS4_OO_CONFIRMED 1 |
J. Bruce Fields | 38c387b | 2011-09-16 17:42:48 -0400 | [diff] [blame] | 373 | #define NFS4_OO_PURGE_CLOSE 2 |
J. Bruce Fields | dad1c06 | 2011-09-12 12:24:13 -0400 | [diff] [blame] | 374 | unsigned char oo_flags; |
J. Bruce Fields | fe0750e | 2011-07-30 23:33:59 -0400 | [diff] [blame] | 375 | }; |
| 376 | |
| 377 | struct nfs4_lockowner { |
| 378 | struct nfs4_stateowner lo_owner; /* must be first element */ |
| 379 | struct list_head lo_perstateid; /* for lockowners only */ |
| 380 | struct list_head lo_list; /* for temporary uses */ |
| 381 | }; |
| 382 | |
| 383 | static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so) |
| 384 | { |
| 385 | return container_of(so, struct nfs4_openowner, oo_owner); |
| 386 | } |
| 387 | |
| 388 | static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so) |
| 389 | { |
| 390 | return container_of(so, struct nfs4_lockowner, lo_owner); |
| 391 | } |
| 392 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 393 | /* |
| 394 | * nfs4_file: a file opened by some number of (open) nfs4_stateowners. |
| 395 | * o fi_perfile list is used to search for conflicting |
| 396 | * share_acces, share_deny on the file. |
| 397 | */ |
| 398 | struct nfs4_file { |
J. Bruce Fields | 8b671b8 | 2009-02-22 14:51:34 -0800 | [diff] [blame] | 399 | atomic_t fi_ref; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 400 | struct list_head fi_hash; /* hash by "struct inode *" */ |
NeilBrown | 8beefa2 | 2005-06-23 22:03:08 -0700 | [diff] [blame] | 401 | struct list_head fi_stateids; |
| 402 | struct list_head fi_delegations; |
J. Bruce Fields | f9d7562 | 2010-07-08 11:02:09 -0400 | [diff] [blame] | 403 | /* One each for O_RDONLY, O_WRONLY, O_RDWR: */ |
| 404 | struct file * fi_fds[3]; |
J. Bruce Fields | f9d7562 | 2010-07-08 11:02:09 -0400 | [diff] [blame] | 405 | /* |
J. Bruce Fields | 6409a5a | 2011-09-28 11:37:56 -0400 | [diff] [blame^] | 406 | * Each open or lock stateid contributes 0-4 to the counts |
| 407 | * below depending on which bits are set in st_access_bitmap: |
| 408 | * 1 to fi_access[O_RDONLY] if NFS4_SHARE_ACCES_READ is set |
| 409 | * + 1 to fi_access[O_WRONLY] if NFS4_SHARE_ACCESS_WRITE is set |
| 410 | * + 1 to both of the above if NFS4_SHARE_ACCESS_BOTH is set. |
J. Bruce Fields | f9d7562 | 2010-07-08 11:02:09 -0400 | [diff] [blame] | 411 | */ |
J. Bruce Fields | 9ae78bc | 2011-03-17 12:52:33 -0400 | [diff] [blame] | 412 | atomic_t fi_access[2]; |
J. Bruce Fields | acfdf5c | 2011-01-31 19:20:39 -0500 | [diff] [blame] | 413 | struct file *fi_deleg_file; |
| 414 | struct file_lock *fi_lease; |
| 415 | atomic_t fi_delegees; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 416 | struct inode *fi_inode; |
Meelap Shah | 47f9940 | 2007-07-17 04:04:40 -0700 | [diff] [blame] | 417 | bool fi_had_conflict; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 418 | }; |
| 419 | |
J. Bruce Fields | f9d7562 | 2010-07-08 11:02:09 -0400 | [diff] [blame] | 420 | /* XXX: for first cut may fall back on returning file that doesn't work |
| 421 | * at all? */ |
| 422 | static inline struct file *find_writeable_file(struct nfs4_file *f) |
| 423 | { |
J. Bruce Fields | 7d94784 | 2010-08-20 18:09:31 -0400 | [diff] [blame] | 424 | if (f->fi_fds[O_WRONLY]) |
| 425 | return f->fi_fds[O_WRONLY]; |
| 426 | return f->fi_fds[O_RDWR]; |
J. Bruce Fields | f9d7562 | 2010-07-08 11:02:09 -0400 | [diff] [blame] | 427 | } |
| 428 | |
| 429 | static inline struct file *find_readable_file(struct nfs4_file *f) |
| 430 | { |
J. Bruce Fields | 7d94784 | 2010-08-20 18:09:31 -0400 | [diff] [blame] | 431 | if (f->fi_fds[O_RDONLY]) |
| 432 | return f->fi_fds[O_RDONLY]; |
| 433 | return f->fi_fds[O_RDWR]; |
J. Bruce Fields | f9d7562 | 2010-07-08 11:02:09 -0400 | [diff] [blame] | 434 | } |
| 435 | |
| 436 | static inline struct file *find_any_file(struct nfs4_file *f) |
| 437 | { |
| 438 | if (f->fi_fds[O_RDWR]) |
| 439 | return f->fi_fds[O_RDWR]; |
J. Bruce Fields | 18608ad | 2010-08-20 18:06:26 -0400 | [diff] [blame] | 440 | else if (f->fi_fds[O_WRONLY]) |
J. Bruce Fields | f9d7562 | 2010-07-08 11:02:09 -0400 | [diff] [blame] | 441 | return f->fi_fds[O_WRONLY]; |
| 442 | else |
| 443 | return f->fi_fds[O_RDONLY]; |
| 444 | } |
| 445 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 446 | /* |
J. Bruce Fields | dcef041 | 2011-09-07 16:06:42 -0400 | [diff] [blame] | 447 | * nfs4_ol_stateid can either be an open stateid or (eventually) a lock stateid |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 448 | * |
J. Bruce Fields | dcef041 | 2011-09-07 16:06:42 -0400 | [diff] [blame] | 449 | * (open)nfs4_ol_stateid: one per (open)nfs4_stateowner, nfs4_file |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 450 | * |
| 451 | * st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry |
| 452 | * st_perfile: file_hashtbl[] entry. |
| 453 | * st_perfile_state: nfs4_stateowner->so_perfilestate |
| 454 | * st_perlockowner: (open stateid) list of lock nfs4_stateowners |
| 455 | * st_access_bmap: used only for open stateid |
| 456 | * st_deny_bmap: used only for open stateid |
NeilBrown | 4c4cd22 | 2005-07-07 17:59:27 -0700 | [diff] [blame] | 457 | * st_openstp: open stateid lock stateid was derived from |
| 458 | * |
| 459 | * XXX: open stateids and lock stateids have diverged sufficiently that |
| 460 | * we should consider defining separate structs for the two cases. |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 461 | */ |
| 462 | |
J. Bruce Fields | d5477a8 | 2011-09-08 12:07:44 -0400 | [diff] [blame] | 463 | /* "ol" stands for "Open or Lock". Better suggestions welcome. */ |
J. Bruce Fields | dcef041 | 2011-09-07 16:06:42 -0400 | [diff] [blame] | 464 | struct nfs4_ol_stateid { |
| 465 | struct nfs4_stid st_stid; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 466 | struct list_head st_perfile; |
NeilBrown | ea1da63 | 2005-06-23 22:04:17 -0700 | [diff] [blame] | 467 | struct list_head st_perstateowner; |
| 468 | struct list_head st_lockowners; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 469 | struct nfs4_stateowner * st_stateowner; |
| 470 | struct nfs4_file * st_file; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 471 | unsigned long st_access_bmap; |
| 472 | unsigned long st_deny_bmap; |
J. Bruce Fields | dcef041 | 2011-09-07 16:06:42 -0400 | [diff] [blame] | 473 | struct nfs4_ol_stateid * st_openstp; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 474 | }; |
| 475 | |
J. Bruce Fields | dcef041 | 2011-09-07 16:06:42 -0400 | [diff] [blame] | 476 | static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s) |
| 477 | { |
| 478 | return container_of(s, struct nfs4_ol_stateid, st_stid); |
| 479 | } |
| 480 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 481 | /* flags for preprocess_seqid_op() */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 482 | #define RD_STATE 0x00000010 |
| 483 | #define WR_STATE 0x00000020 |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 484 | |
Benny Halevy | dd453df | 2009-04-03 08:28:41 +0300 | [diff] [blame] | 485 | struct nfsd4_compound_state; |
| 486 | |
| 487 | extern __be32 nfs4_preprocess_stateid_op(struct nfsd4_compound_state *cstate, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 488 | stateid_t *stateid, int flags, struct file **filp); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 489 | extern void nfs4_lock_state(void); |
| 490 | extern void nfs4_unlock_state(void); |
| 491 | extern int nfs4_in_grace(void); |
Al Viro | b37ad28 | 2006-10-19 23:28:59 -0700 | [diff] [blame] | 492 | extern __be32 nfs4_check_open_reclaim(clientid_t *clid); |
J. Bruce Fields | fe0750e | 2011-07-30 23:33:59 -0400 | [diff] [blame] | 493 | extern void nfs4_free_openowner(struct nfs4_openowner *); |
| 494 | extern void nfs4_free_lockowner(struct nfs4_lockowner *); |
J. Bruce Fields | 80fc015 | 2009-09-15 18:07:35 -0400 | [diff] [blame] | 495 | extern int set_callback_cred(void); |
J. Bruce Fields | 5a3c9d7 | 2010-10-19 17:56:52 -0400 | [diff] [blame] | 496 | extern void nfsd4_probe_callback(struct nfs4_client *clp); |
J. Bruce Fields | 84f5f7c | 2010-12-09 15:52:19 -0500 | [diff] [blame] | 497 | extern void nfsd4_probe_callback_sync(struct nfs4_client *clp); |
J. Bruce Fields | 5a3c9d7 | 2010-10-19 17:56:52 -0400 | [diff] [blame] | 498 | extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *); |
J. Bruce Fields | b5a1a81 | 2010-03-03 14:52:55 -0500 | [diff] [blame] | 499 | extern void nfsd4_do_callback_rpc(struct work_struct *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 500 | extern void nfsd4_cb_recall(struct nfs4_delegation *dp); |
J. Bruce Fields | b5a1a81 | 2010-03-03 14:52:55 -0500 | [diff] [blame] | 501 | extern int nfsd4_create_callback_queue(void); |
| 502 | extern void nfsd4_destroy_callback_queue(void); |
J. Bruce Fields | 6ff8da0 | 2010-06-04 20:04:45 -0400 | [diff] [blame] | 503 | extern void nfsd4_shutdown_callback(struct nfs4_client *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 504 | extern void nfs4_put_delegation(struct nfs4_delegation *dp); |
Al Viro | b37ad28 | 2006-10-19 23:28:59 -0700 | [diff] [blame] | 505 | extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname); |
J. Bruce Fields | 48483bf | 2011-08-26 20:40:28 -0400 | [diff] [blame] | 506 | extern void nfsd4_init_recdir(void); |
NeilBrown | 190e4fb | 2005-06-23 22:04:25 -0700 | [diff] [blame] | 507 | extern int nfsd4_recdir_load(void); |
| 508 | extern void nfsd4_shutdown_recdir(void); |
| 509 | extern int nfs4_client_to_reclaim(const char *name); |
Andy Adamson | a1bcecd | 2009-04-03 08:28:05 +0300 | [diff] [blame] | 510 | extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id); |
NeilBrown | c7b9a45 | 2005-06-23 22:04:30 -0700 | [diff] [blame] | 511 | extern void nfsd4_recdir_purge_old(void); |
| 512 | extern int nfsd4_create_clid_dir(struct nfs4_client *clp); |
| 513 | extern void nfsd4_remove_clid_dir(struct nfs4_client *clp); |
Benny Halevy | d768298 | 2010-05-12 00:13:54 +0300 | [diff] [blame] | 514 | extern void release_session_client(struct nfsd4_session *); |
J. Bruce Fields | 38c2f4b | 2011-09-23 17:01:19 -0400 | [diff] [blame] | 515 | extern __be32 nfs4_validate_stateid(struct nfs4_client *, stateid_t *); |
J. Bruce Fields | 38c387b | 2011-09-16 17:42:48 -0400 | [diff] [blame] | 516 | extern void nfsd4_purge_closed_stateid(struct nfs4_stateowner *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 517 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 518 | #endif /* NFSD4_STATE_H */ |