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/nfsd/nfsfh.h> 39 #include "nfsfh.h" 40 41 typedef struct { 42 u32 cl_boot; 43 u32 cl_id; 44 } clientid_t; 45 46 typedef struct { 47 u32 so_boot; 48 u32 so_stateownerid; 49 u32 so_fileid; 50 } stateid_opaque_t; 51 52 typedef struct { 53 u32 si_generation; 54 stateid_opaque_t si_opaque; 55 } stateid_t; 56 #define si_boot si_opaque.so_boot 57 #define si_stateownerid si_opaque.so_stateownerid 58 #define si_fileid si_opaque.so_fileid 59 60 #define STATEID_FMT "(%08x/%08x/%08x/%08x)" 61 #define STATEID_VAL(s) \ 62 (s)->si_boot, \ 63 (s)->si_stateownerid, \ 64 (s)->si_fileid, \ 65 (s)->si_generation 66 67 struct nfsd4_cb_sequence { 68 /* args/res */ 69 u32 cbs_minorversion; 70 struct nfs4_client *cbs_clp; 71 }; 72 73 struct nfs4_rpc_args { 74 void *args_op; 75 struct nfsd4_cb_sequence args_seq; 76 }; 77 78 struct nfsd4_callback { 79 struct nfs4_rpc_args cb_args; 80 struct work_struct cb_work; 81 }; 82 83 struct nfs4_delegation { 84 struct list_head dl_perfile; 85 struct list_head dl_perclnt; 86 struct list_head dl_recall_lru; /* delegation recalled */ 87 atomic_t dl_count; /* ref count */ 88 struct nfs4_client *dl_client; 89 struct nfs4_file *dl_file; 90 struct file_lock *dl_flock; 91 struct file *dl_vfs_file; 92 u32 dl_type; 93 time_t dl_time; 94 /* For recall: */ 95 u32 dl_ident; 96 stateid_t dl_stateid; 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 size_t cb_addrlen; 107 u32 cb_prog; 108 u32 cb_minorversion; 109 u32 cb_ident; /* minorversion 0 only */ 110 struct svc_xprt *cb_xprt; /* minorversion 1 only */ 111 }; 112 113 /* Maximum number of slots per session. 160 is useful for long haul TCP */ 114 #define NFSD_MAX_SLOTS_PER_SESSION 160 115 /* Maximum number of operations per session compound */ 116 #define NFSD_MAX_OPS_PER_COMPOUND 16 117 /* Maximum session per slot cache size */ 118 #define NFSD_SLOT_CACHE_SIZE 1024 119 /* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */ 120 #define NFSD_CACHE_SIZE_SLOTS_PER_SESSION 32 121 #define NFSD_MAX_MEM_PER_SESSION \ 122 (NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE) 123 124 struct nfsd4_slot { 125 bool sl_inuse; 126 bool sl_cachethis; 127 u16 sl_opcnt; 128 u32 sl_seqid; 129 __be32 sl_status; 130 u32 sl_datalen; 131 char sl_data[]; 132 }; 133 134 struct nfsd4_channel_attrs { 135 u32 headerpadsz; 136 u32 maxreq_sz; 137 u32 maxresp_sz; 138 u32 maxresp_cached; 139 u32 maxops; 140 u32 maxreqs; 141 u32 nr_rdma_attrs; 142 u32 rdma_attrs; 143 }; 144 145 struct nfsd4_create_session { 146 clientid_t clientid; 147 struct nfs4_sessionid sessionid; 148 u32 seqid; 149 u32 flags; 150 struct nfsd4_channel_attrs fore_channel; 151 struct nfsd4_channel_attrs back_channel; 152 u32 callback_prog; 153 u32 uid; 154 u32 gid; 155 }; 156 157 /* The single slot clientid cache structure */ 158 struct nfsd4_clid_slot { 159 u32 sl_seqid; 160 __be32 sl_status; 161 struct nfsd4_create_session sl_cr_ses; 162 }; 163 164 struct nfsd4_session { 165 struct kref se_ref; 166 struct list_head se_hash; /* hash by sessionid */ 167 struct list_head se_perclnt; 168 u32 se_flags; 169 struct nfs4_client *se_client; 170 struct nfs4_sessionid se_sessionid; 171 struct nfsd4_channel_attrs se_fchannel; 172 struct nfsd4_channel_attrs se_bchannel; 173 struct nfsd4_slot *se_slots[]; /* forward channel slots */ 174 }; 175 176 static inline void 177 nfsd4_put_session(struct nfsd4_session *ses) 178 { 179 extern void free_session(struct kref *kref); 180 kref_put(&ses->se_ref, free_session); 181 } 182 183 static inline void 184 nfsd4_get_session(struct nfsd4_session *ses) 185 { 186 kref_get(&ses->se_ref); 187 } 188 189 /* formatted contents of nfs4_sessionid */ 190 struct nfsd4_sessionid { 191 clientid_t clientid; 192 u32 sequence; 193 u32 reserved; 194 }; 195 196 #define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */ 197 198 /* 199 * struct nfs4_client - one per client. Clientids live here. 200 * o Each nfs4_client is hashed by clientid. 201 * 202 * o Each nfs4_clients is also hashed by name 203 * (the opaque quantity initially sent by the client to identify itself). 204 * 205 * o cl_perclient list is used to ensure no dangling stateowner references 206 * when we expire the nfs4_client 207 */ 208 struct nfs4_client { 209 struct list_head cl_idhash; /* hash by cl_clientid.id */ 210 struct list_head cl_strhash; /* hash by cl_name */ 211 struct list_head cl_openowners; 212 struct list_head cl_delegations; 213 struct list_head cl_lru; /* tail queue */ 214 struct xdr_netobj cl_name; /* id generated by client */ 215 char cl_recdir[HEXDIR_LEN]; /* recovery dir */ 216 nfs4_verifier cl_verifier; /* generated by client */ 217 time_t cl_time; /* time of last lease renewal */ 218 struct sockaddr_storage cl_addr; /* client ipaddress */ 219 u32 cl_flavor; /* setclientid pseudoflavor */ 220 char *cl_principal; /* setclientid principal name */ 221 struct svc_cred cl_cred; /* setclientid principal */ 222 clientid_t cl_clientid; /* generated by server */ 223 nfs4_verifier cl_confirm; /* generated by server */ 224 u32 cl_firststate; /* recovery dir creation */ 225 226 /* for v4.0 and v4.1 callbacks: */ 227 struct nfs4_cb_conn cl_cb_conn; 228 struct rpc_clnt *cl_cb_client; 229 atomic_t cl_cb_set; 230 231 /* for nfs41 */ 232 struct list_head cl_sessions; 233 struct nfsd4_clid_slot cl_cs_slot; /* create_session slot */ 234 u32 cl_exchange_flags; 235 struct nfs4_sessionid cl_sessionid; 236 /* number of rpc's in progress over an associated session: */ 237 atomic_t cl_refcount; 238 239 /* for nfs41 callbacks */ 240 /* We currently support a single back channel with a single slot */ 241 unsigned long cl_cb_slot_busy; 242 u32 cl_cb_seq_nr; 243 struct rpc_wait_queue cl_cb_waitq; /* backchannel callers may */ 244 /* wait here for slots */ 245 }; 246 247 static inline void 248 mark_client_expired(struct nfs4_client *clp) 249 { 250 clp->cl_time = 0; 251 } 252 253 static inline bool 254 is_client_expired(struct nfs4_client *clp) 255 { 256 return clp->cl_time == 0; 257 } 258 259 /* struct nfs4_client_reset 260 * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl 261 * upon lease reset, or from upcall to state_daemon (to read in state 262 * from non-volitile storage) upon reboot. 263 */ 264 struct nfs4_client_reclaim { 265 struct list_head cr_strhash; /* hash by cr_name */ 266 char cr_recdir[HEXDIR_LEN]; /* recover dir */ 267 }; 268 269 static inline void 270 update_stateid(stateid_t *stateid) 271 { 272 stateid->si_generation++; 273 } 274 275 /* A reasonable value for REPLAY_ISIZE was estimated as follows: 276 * The OPEN response, typically the largest, requires 277 * 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) + 278 * 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) + 279 * 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes 280 */ 281 282 #define NFSD4_REPLAY_ISIZE 112 283 284 /* 285 * Replay buffer, where the result of the last seqid-mutating operation 286 * is cached. 287 */ 288 struct nfs4_replay { 289 __be32 rp_status; 290 unsigned int rp_buflen; 291 char *rp_buf; 292 unsigned intrp_allocated; 293 struct knfsd_fh rp_openfh; 294 char rp_ibuf[NFSD4_REPLAY_ISIZE]; 295 }; 296 297 /* 298 * nfs4_stateowner can either be an open_owner, or a lock_owner 299 * 300 * so_idhash: stateid_hashtbl[] for open owner, lockstateid_hashtbl[] 301 * for lock_owner 302 * so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[] 303 * for lock_owner 304 * so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client 305 * struct is reaped. 306 * so_perfilestate: heads the list of nfs4_stateid (either open or lock) 307 * and is used to ensure no dangling nfs4_stateid references when we 308 * release a stateowner. 309 * so_perlockowner: (open) nfs4_stateid->st_perlockowner entry - used when 310 * close is called to reap associated byte-range locks 311 * so_close_lru: (open) stateowner is placed on this list instead of being 312 * reaped (when so_perfilestate is empty) to hold the last close replay. 313 * reaped by laundramat thread after lease period. 314 */ 315 struct nfs4_stateowner { 316 struct kref so_ref; 317 struct list_head so_idhash; /* hash by so_id */ 318 struct list_head so_strhash; /* hash by op_name */ 319 struct list_head so_perclient; 320 struct list_head so_stateids; 321 struct list_head so_perstateid; /* for lockowners only */ 322 struct list_head so_close_lru; /* tail queue */ 323 time_t so_time; /* time of placement on so_close_lru */ 324 int so_is_open_owner; /* 1=openowner,0=lockowner */ 325 u32 so_id; 326 struct nfs4_client * so_client; 327 /* after increment in ENCODE_SEQID_OP_TAIL, represents the next 328 * sequence id expected from the client: */ 329 u32 so_seqid; 330 struct xdr_netobj so_owner; /* open owner name */ 331 int so_confirmed; /* successful OPEN_CONFIRM? */ 332 struct nfs4_replay so_replay; 333 }; 334 335 /* 336 * nfs4_file: a file opened by some number of (open) nfs4_stateowners. 337 * o fi_perfile list is used to search for conflicting 338 * share_acces, share_deny on the file. 339 */ 340 struct nfs4_file { 341 atomic_t fi_ref; 342 struct list_head fi_hash; /* hash by "struct inode *" */ 343 struct list_head fi_stateids; 344 struct list_head fi_delegations; 345 struct inode *fi_inode; 346 u32 fi_id; /* used with stateowner->so_id 347 * for stateid_hashtbl hash */ 348 bool fi_had_conflict; 349 }; 350 351 /* 352 * nfs4_stateid can either be an open stateid or (eventually) a lock stateid 353 * 354 * (open)nfs4_stateid: one per (open)nfs4_stateowner, nfs4_file 355 * 356 * st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry 357 * st_perfile: file_hashtbl[] entry. 358 * st_perfile_state: nfs4_stateowner->so_perfilestate 359 * st_perlockowner: (open stateid) list of lock nfs4_stateowners 360 * st_access_bmap: used only for open stateid 361 * st_deny_bmap: used only for open stateid 362 * st_openstp: open stateid lock stateid was derived from 363 * 364 * XXX: open stateids and lock stateids have diverged sufficiently that 365 * we should consider defining separate structs for the two cases. 366 */ 367 368 struct nfs4_stateid { 369 struct list_head st_hash; 370 struct list_head st_perfile; 371 struct list_head st_perstateowner; 372 struct list_head st_lockowners; 373 struct nfs4_stateowner * st_stateowner; 374 struct nfs4_file * st_file; 375 stateid_t st_stateid; 376 struct file * st_vfs_file; 377 unsigned long st_access_bmap; 378 unsigned long st_deny_bmap; 379 struct nfs4_stateid * st_openstp; 380 }; 381 382 /* flags for preprocess_seqid_op() */ 383 #define HAS_SESSION 0x00000001 384 #define CONFIRM 0x00000002 385 #define OPEN_STATE 0x00000004 386 #define LOCK_STATE 0x00000008 387 #define RD_STATE 0x00000010 388 #define WR_STATE 0x00000020 389 #define CLOSE_STATE 0x00000040 390 391 #define seqid_mutating_err(err) \ 392 (((err) != nfserr_stale_clientid) && \ 393 ((err) != nfserr_bad_seqid) && \ 394 ((err) != nfserr_stale_stateid) && \ 395 ((err) != nfserr_bad_stateid)) 396 397 struct nfsd4_compound_state; 398 399 extern __be32 nfs4_preprocess_stateid_op(struct nfsd4_compound_state *cstate, 400 stateid_t *stateid, int flags, struct file **filp); 401 extern void nfs4_lock_state(void); 402 extern void nfs4_unlock_state(void); 403 extern int nfs4_in_grace(void); 404 extern __be32 nfs4_check_open_reclaim(clientid_t *clid); 405 extern void nfs4_free_stateowner(struct kref *kref); 406 extern int set_callback_cred(void); 407 extern void nfsd4_probe_callback(struct nfs4_client *clp, struct nfs4_cb_conn *); 408 extern void nfsd4_do_callback_rpc(struct work_struct *); 409 extern void nfsd4_cb_recall(struct nfs4_delegation *dp); 410 extern int nfsd4_create_callback_queue(void); 411 extern void nfsd4_destroy_callback_queue(void); 412 extern void nfsd4_set_callback_client(struct nfs4_client *, struct rpc_clnt *); 413 extern void nfs4_put_delegation(struct nfs4_delegation *dp); 414 extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname); 415 extern void nfsd4_init_recdir(char *recdir_name); 416 extern int nfsd4_recdir_load(void); 417 extern void nfsd4_shutdown_recdir(void); 418 extern int nfs4_client_to_reclaim(const char *name); 419 extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id); 420 extern void nfsd4_recdir_purge_old(void); 421 extern int nfsd4_create_clid_dir(struct nfs4_client *clp); 422 extern void nfsd4_remove_clid_dir(struct nfs4_client *clp); 423 extern void release_session_client(struct nfsd4_session *); 424 425 static inline void 426 nfs4_put_stateowner(struct nfs4_stateowner *so) 427 { 428 kref_put(&so->so_ref, nfs4_free_stateowner); 429 } 430 431 static inline void 432 nfs4_get_stateowner(struct nfs4_stateowner *so) 433 { 434 kref_get(&so->so_ref); 435 } 436 437 #endif /* NFSD4_STATE_H */ 438