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