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