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