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/idr.h> 39 #include <linux/sunrpc/svc_xprt.h> 40 #include <linux/nfsd/nfsfh.h> 41 #include "nfsfh.h" 42 43 typedef struct { 44 u32 cl_boot; 45 u32 cl_id; 46 } clientid_t; 47 48 typedef struct { 49 clientid_t so_clid; 50 u32 so_id; 51 } stateid_opaque_t; 52 53 typedef struct { 54 u32 si_generation; 55 stateid_opaque_t si_opaque; 56 } stateid_t; 57 58 #define STATEID_FMT "(%08x/%08x/%08x/%08x)" 59 #define STATEID_VAL(s) \ 60 (s)->si_opaque.so_clid.cl_boot, \ 61 (s)->si_opaque.so_clid.cl_id, \ 62 (s)->si_opaque.so_id, \ 63 (s)->si_generation 64 65 struct nfsd4_callback { 66 void *cb_op; 67 struct nfs4_client *cb_clp; 68 struct list_head cb_per_client; 69 u32 cb_minorversion; 70 struct rpc_message cb_msg; 71 const struct rpc_call_ops *cb_ops; 72 struct work_struct cb_work; 73 bool cb_done; 74 }; 75 76 struct nfs4_stid { 77 #define NFS4_OPEN_STID 1 78 #define NFS4_LOCK_STID 2 79 #define NFS4_DELEG_STID 4 80 /* For an open stateid kept around *only* to process close replays: */ 81 #define NFS4_CLOSED_STID 8 82 unsigned char sc_type; 83 stateid_t sc_stateid; 84 struct nfs4_client *sc_client; 85 }; 86 87 struct nfs4_delegation { 88 struct nfs4_stid dl_stid; /* must be first field */ 89 struct list_head dl_perfile; 90 struct list_head dl_perclnt; 91 struct list_head dl_recall_lru; /* delegation recalled */ 92 atomic_t dl_count; /* ref count */ 93 struct nfs4_file *dl_file; 94 u32 dl_type; 95 time_t dl_time; 96 /* For recall: */ 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 struct sockaddr_storage cb_saddr; 107 size_t cb_addrlen; 108 u32 cb_prog; /* used only in 4.0 case; 109 per-session otherwise */ 110 u32 cb_ident; /* minorversion 0 only */ 111 struct svc_xprt *cb_xprt; /* minorversion 1 only */ 112 }; 113 114 static inline struct nfs4_delegation *delegstateid(struct nfs4_stid *s) 115 { 116 return container_of(s, struct nfs4_delegation, dl_stid); 117 } 118 119 /* Maximum number of slots per session. 160 is useful for long haul TCP */ 120 #define NFSD_MAX_SLOTS_PER_SESSION 160 121 /* Maximum number of operations per session compound */ 122 #define NFSD_MAX_OPS_PER_COMPOUND 16 123 /* Maximum session per slot cache size */ 124 #define NFSD_SLOT_CACHE_SIZE 1024 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) 129 130 struct nfsd4_slot { 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[]; 138 }; 139 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 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 163 struct nfsd4_bind_conn_to_session { 164 struct nfs4_sessionid sessionid; 165 u32 dir; 166 }; 167 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 175 struct nfsd4_conn { 176 struct list_head cn_persession; 177 struct svc_xprt *cn_xprt; 178 struct svc_xpt_user cn_xpt_user; 179 struct nfsd4_session *cn_session; 180 /* CDFC4_FORE, CDFC4_BACK: */ 181 unsigned char cn_flags; 182 }; 183 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; 189 struct nfs4_client *se_client; 190 struct nfs4_sessionid se_sessionid; 191 struct nfsd4_channel_attrs se_fchannel; 192 struct nfsd4_channel_attrs se_bchannel; 193 struct list_head se_conns; 194 u32 se_cb_prog; 195 u32 se_cb_seq_nr; 196 struct nfsd4_slot *se_slots[]; /* forward channel slots */ 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 212 /* formatted contents of nfs4_sessionid */ 213 struct nfsd4_sessionid { 214 clientid_t clientid; 215 u32 sequence; 216 u32 reserved; 217 }; 218 219 #define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */ 220 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 */ 234 struct list_head cl_openowners; 235 struct idr cl_stateids; /* stateid lookup */ 236 struct list_head cl_delegations; 237 struct list_head cl_lru; /* tail queue */ 238 struct xdr_netobj cl_name; /* id generated by client */ 239 char cl_recdir[HEXDIR_LEN]; /* recovery dir */ 240 nfs4_verifier cl_verifier; /* generated by client */ 241 time_t cl_time; /* time of last lease renewal */ 242 struct sockaddr_storage cl_addr; /* client ipaddress */ 243 u32 cl_flavor; /* setclientid pseudoflavor */ 244 char *cl_principal; /* setclientid principal name */ 245 struct svc_cred cl_cred; /* setclientid principal */ 246 clientid_t cl_clientid; /* generated by server */ 247 nfs4_verifier cl_confirm; /* generated by server */ 248 u32 cl_firststate; /* recovery dir creation */ 249 u32 cl_minorversion; 250 251 /* for v4.0 and v4.1 callbacks: */ 252 struct nfs4_cb_conn cl_cb_conn; 253 #define NFSD4_CLIENT_CB_UPDATE 1 254 #define NFSD4_CLIENT_KILL 2 255 unsigned long cl_cb_flags; 256 struct rpc_clnt *cl_cb_client; 257 u32 cl_cb_ident; 258 #define NFSD4_CB_UP 0 259 #define NFSD4_CB_UNKNOWN 1 260 #define NFSD4_CB_DOWN 2 261 #define NFSD4_CB_FAULT 3 262 int cl_cb_state; 263 struct nfsd4_callback cl_cb_null; 264 struct nfsd4_session *cl_cb_session; 265 struct list_head cl_callbacks; /* list of in-progress callbacks */ 266 267 /* for all client information that callback code might need: */ 268 spinlock_t cl_lock; 269 270 /* for nfs41 */ 271 struct list_head cl_sessions; 272 struct nfsd4_clid_slot cl_cs_slot; /* create_session slot */ 273 u32 cl_exchange_flags; 274 /* number of rpc's in progress over an associated session: */ 275 atomic_t cl_refcount; 276 277 /* for nfs41 callbacks */ 278 /* We currently support a single back channel with a single slot */ 279 unsigned long cl_cb_slot_busy; 280 struct rpc_wait_queue cl_cb_waitq; /* backchannel callers may */ 281 /* wait here for slots */ 282 }; 283 284 static inline void 285 mark_client_expired(struct nfs4_client *clp) 286 { 287 clp->cl_time = 0; 288 } 289 290 static inline bool 291 is_client_expired(struct nfs4_client *clp) 292 { 293 return clp->cl_time == 0; 294 } 295 296 /* struct nfs4_client_reset 297 * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl 298 * upon lease reset, or from upcall to state_daemon (to read in state 299 * from non-volitile storage) upon reboot. 300 */ 301 struct nfs4_client_reclaim { 302 struct list_head cr_strhash; /* hash by cr_name */ 303 char cr_recdir[HEXDIR_LEN]; /* recover dir */ 304 }; 305 306 static inline void 307 update_stateid(stateid_t *stateid) 308 { 309 stateid->si_generation++; 310 /* Wraparound recommendation from 3530bis-13 9.1.3.2: */ 311 if (stateid->si_generation == 0) 312 stateid->si_generation = 1; 313 } 314 315 /* A reasonable value for REPLAY_ISIZE was estimated as follows: 316 * The OPEN response, typically the largest, requires 317 * 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) + 318 * 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) + 319 * 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes 320 */ 321 322 #define NFSD4_REPLAY_ISIZE 112 323 324 /* 325 * Replay buffer, where the result of the last seqid-mutating operation 326 * is cached. 327 */ 328 struct nfs4_replay { 329 __be32 rp_status; 330 unsigned int rp_buflen; 331 char *rp_buf; 332 struct knfsd_fh rp_openfh; 333 char rp_ibuf[NFSD4_REPLAY_ISIZE]; 334 }; 335 336 struct nfs4_stateowner { 337 struct list_head so_strhash; /* hash by op_name */ 338 struct list_head so_stateids; 339 struct nfs4_client * so_client; 340 /* after increment in ENCODE_SEQID_OP_TAIL, represents the next 341 * sequence id expected from the client: */ 342 u32 so_seqid; 343 struct xdr_netobj so_owner; /* open owner name */ 344 struct nfs4_replay so_replay; 345 bool so_is_open_owner; 346 }; 347 348 struct nfs4_openowner { 349 struct nfs4_stateowner oo_owner; /* must be first field */ 350 struct list_head oo_perclient; 351 /* 352 * We keep around openowners a little while after last close, 353 * which saves clients from having to confirm, and allows us to 354 * handle close replays if they come soon enough. The close_lru 355 * is a list of such openowners, to be reaped by the laundromat 356 * thread eventually if they remain unused: 357 */ 358 struct list_head oo_close_lru; 359 struct nfs4_ol_stateid *oo_last_closed_stid; 360 time_t oo_time; /* time of placement on so_close_lru */ 361 #define NFS4_OO_CONFIRMED 1 362 #define NFS4_OO_PURGE_CLOSE 2 363 #define NFS4_OO_NEW 4 364 unsigned char oo_flags; 365 }; 366 367 struct nfs4_lockowner { 368 struct nfs4_stateowner lo_owner; /* must be first element */ 369 struct list_head lo_owner_ino_hash; /* hash by owner,file */ 370 struct list_head lo_perstateid; /* for lockowners only */ 371 struct list_head lo_list; /* for temporary uses */ 372 }; 373 374 static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so) 375 { 376 return container_of(so, struct nfs4_openowner, oo_owner); 377 } 378 379 static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so) 380 { 381 return container_of(so, struct nfs4_lockowner, lo_owner); 382 } 383 384 /* 385 * nfs4_file: a file opened by some number of (open) nfs4_stateowners. 386 * o fi_perfile list is used to search for conflicting 387 * share_acces, share_deny on the file. 388 */ 389 struct nfs4_file { 390 atomic_t fi_ref; 391 struct list_head fi_hash; /* hash by "struct inode *" */ 392 struct list_head fi_stateids; 393 struct list_head fi_delegations; 394 /* One each for O_RDONLY, O_WRONLY, O_RDWR: */ 395 struct file * fi_fds[3]; 396 /* 397 * Each open or lock stateid contributes 0-4 to the counts 398 * below depending on which bits are set in st_access_bitmap: 399 * 1 to fi_access[O_RDONLY] if NFS4_SHARE_ACCES_READ is set 400 * + 1 to fi_access[O_WRONLY] if NFS4_SHARE_ACCESS_WRITE is set 401 * + 1 to both of the above if NFS4_SHARE_ACCESS_BOTH is set. 402 */ 403 atomic_t fi_access[2]; 404 struct file *fi_deleg_file; 405 struct file_lock *fi_lease; 406 atomic_t fi_delegees; 407 struct inode *fi_inode; 408 bool fi_had_conflict; 409 }; 410 411 /* XXX: for first cut may fall back on returning file that doesn't work 412 * at all? */ 413 static inline struct file *find_writeable_file(struct nfs4_file *f) 414 { 415 if (f->fi_fds[O_WRONLY]) 416 return f->fi_fds[O_WRONLY]; 417 return f->fi_fds[O_RDWR]; 418 } 419 420 static inline struct file *find_readable_file(struct nfs4_file *f) 421 { 422 if (f->fi_fds[O_RDONLY]) 423 return f->fi_fds[O_RDONLY]; 424 return f->fi_fds[O_RDWR]; 425 } 426 427 static inline struct file *find_any_file(struct nfs4_file *f) 428 { 429 if (f->fi_fds[O_RDWR]) 430 return f->fi_fds[O_RDWR]; 431 else if (f->fi_fds[O_WRONLY]) 432 return f->fi_fds[O_WRONLY]; 433 else 434 return f->fi_fds[O_RDONLY]; 435 } 436 437 /* "ol" stands for "Open or Lock". Better suggestions welcome. */ 438 struct nfs4_ol_stateid { 439 struct nfs4_stid st_stid; /* must be first field */ 440 struct list_head st_perfile; 441 struct list_head st_perstateowner; 442 struct list_head st_lockowners; 443 struct nfs4_stateowner * st_stateowner; 444 struct nfs4_file * st_file; 445 unsigned long st_access_bmap; 446 unsigned long st_deny_bmap; 447 struct nfs4_ol_stateid * st_openstp; 448 }; 449 450 static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s) 451 { 452 return container_of(s, struct nfs4_ol_stateid, st_stid); 453 } 454 455 /* flags for preprocess_seqid_op() */ 456 #define RD_STATE 0x00000010 457 #define WR_STATE 0x00000020 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_openowner(struct nfs4_openowner *); 468 extern void nfs4_free_lockowner(struct nfs4_lockowner *); 469 extern int set_callback_cred(void); 470 extern void nfsd4_probe_callback(struct nfs4_client *clp); 471 extern void nfsd4_probe_callback_sync(struct nfs4_client *clp); 472 extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *); 473 extern void nfsd4_do_callback_rpc(struct work_struct *); 474 extern void nfsd4_cb_recall(struct nfs4_delegation *dp); 475 extern int nfsd4_create_callback_queue(void); 476 extern void nfsd4_destroy_callback_queue(void); 477 extern void nfsd4_shutdown_callback(struct nfs4_client *); 478 extern void nfs4_put_delegation(struct nfs4_delegation *dp); 479 extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname); 480 extern void nfsd4_init_recdir(void); 481 extern int nfsd4_recdir_load(void); 482 extern void nfsd4_shutdown_recdir(void); 483 extern int nfs4_client_to_reclaim(const char *name); 484 extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id); 485 extern void nfsd4_recdir_purge_old(void); 486 extern void nfsd4_create_clid_dir(struct nfs4_client *clp); 487 extern void nfsd4_remove_clid_dir(struct nfs4_client *clp); 488 extern void release_session_client(struct nfsd4_session *); 489 extern __be32 nfs4_validate_stateid(struct nfs4_client *, stateid_t *); 490 extern void nfsd4_purge_closed_stateid(struct nfs4_stateowner *); 491 492 #endif /* NFSD4_STATE_H */ 493