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 u32 sl_seqid; 132 __be32 sl_status; 133 u32 sl_datalen; 134 u16 sl_opcnt; 135 #define NFSD4_SLOT_INUSE (1 << 0) 136 #define NFSD4_SLOT_CACHETHIS (1 << 1) 137 #define NFSD4_SLOT_INITIALIZED (1 << 2) 138 u8 sl_flags; 139 char sl_data[]; 140 }; 141 142 struct nfsd4_channel_attrs { 143 u32 headerpadsz; 144 u32 maxreq_sz; 145 u32 maxresp_sz; 146 u32 maxresp_cached; 147 u32 maxops; 148 u32 maxreqs; 149 u32 nr_rdma_attrs; 150 u32 rdma_attrs; 151 }; 152 153 struct nfsd4_create_session { 154 clientid_t clientid; 155 struct nfs4_sessionid sessionid; 156 u32 seqid; 157 u32 flags; 158 struct nfsd4_channel_attrs fore_channel; 159 struct nfsd4_channel_attrs back_channel; 160 u32 callback_prog; 161 u32 uid; 162 u32 gid; 163 }; 164 165 struct nfsd4_bind_conn_to_session { 166 struct nfs4_sessionid sessionid; 167 u32 dir; 168 }; 169 170 /* The single slot clientid cache structure */ 171 struct nfsd4_clid_slot { 172 u32 sl_seqid; 173 __be32 sl_status; 174 struct nfsd4_create_session sl_cr_ses; 175 }; 176 177 struct nfsd4_conn { 178 struct list_head cn_persession; 179 struct svc_xprt *cn_xprt; 180 struct svc_xpt_user cn_xpt_user; 181 struct nfsd4_session *cn_session; 182 /* CDFC4_FORE, CDFC4_BACK: */ 183 unsigned char cn_flags; 184 }; 185 186 struct nfsd4_session { 187 struct kref se_ref; 188 struct list_head se_hash; /* hash by sessionid */ 189 struct list_head se_perclnt; 190 u32 se_flags; 191 struct nfs4_client *se_client; 192 struct nfs4_sessionid se_sessionid; 193 struct nfsd4_channel_attrs se_fchannel; 194 struct nfsd4_channel_attrs se_bchannel; 195 struct list_head se_conns; 196 u32 se_cb_prog; 197 u32 se_cb_seq_nr; 198 struct nfsd4_slot *se_slots[]; /* forward channel slots */ 199 }; 200 201 extern void nfsd4_put_session(struct nfsd4_session *ses); 202 203 /* formatted contents of nfs4_sessionid */ 204 struct nfsd4_sessionid { 205 clientid_t clientid; 206 u32 sequence; 207 u32 reserved; 208 }; 209 210 #define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */ 211 212 /* 213 * struct nfs4_client - one per client. Clientids live here. 214 * o Each nfs4_client is hashed by clientid. 215 * 216 * o Each nfs4_clients is also hashed by name 217 * (the opaque quantity initially sent by the client to identify itself). 218 * 219 * o cl_perclient list is used to ensure no dangling stateowner references 220 * when we expire the nfs4_client 221 */ 222 struct nfs4_client { 223 struct list_head cl_idhash; /* hash by cl_clientid.id */ 224 struct list_head cl_strhash; /* hash by cl_name */ 225 struct list_head cl_openowners; 226 struct idr cl_stateids; /* stateid lookup */ 227 struct list_head cl_delegations; 228 struct list_head cl_lru; /* tail queue */ 229 struct xdr_netobj cl_name; /* id generated by client */ 230 char cl_recdir[HEXDIR_LEN]; /* recovery dir */ 231 nfs4_verifier cl_verifier; /* generated by client */ 232 time_t cl_time; /* time of last lease renewal */ 233 struct sockaddr_storage cl_addr; /* client ipaddress */ 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_minorversion; 238 239 /* for v4.0 and v4.1 callbacks: */ 240 struct nfs4_cb_conn cl_cb_conn; 241 #define NFSD4_CLIENT_CB_UPDATE (0) 242 #define NFSD4_CLIENT_CB_KILL (1) 243 #define NFSD4_CLIENT_STABLE (2) /* client on stable storage */ 244 #define NFSD4_CLIENT_RECLAIM_COMPLETE (3) /* reclaim_complete done */ 245 #define NFSD4_CLIENT_CB_FLAG_MASK (1 << NFSD4_CLIENT_CB_UPDATE | \ 246 1 << NFSD4_CLIENT_CB_KILL) 247 unsigned long cl_flags; 248 struct rpc_clnt *cl_cb_client; 249 u32 cl_cb_ident; 250 #define NFSD4_CB_UP 0 251 #define NFSD4_CB_UNKNOWN 1 252 #define NFSD4_CB_DOWN 2 253 #define NFSD4_CB_FAULT 3 254 int cl_cb_state; 255 struct nfsd4_callback cl_cb_null; 256 struct nfsd4_session *cl_cb_session; 257 struct list_head cl_callbacks; /* list of in-progress callbacks */ 258 259 /* for all client information that callback code might need: */ 260 spinlock_t cl_lock; 261 262 /* for nfs41 */ 263 struct list_head cl_sessions; 264 struct nfsd4_clid_slot cl_cs_slot; /* create_session slot */ 265 u32 cl_exchange_flags; 266 /* number of rpc's in progress over an associated session: */ 267 atomic_t cl_refcount; 268 269 /* for nfs41 callbacks */ 270 /* We currently support a single back channel with a single slot */ 271 unsigned long cl_cb_slot_busy; 272 struct rpc_wait_queue cl_cb_waitq; /* backchannel callers may */ 273 /* wait here for slots */ 274 }; 275 276 static inline void 277 mark_client_expired(struct nfs4_client *clp) 278 { 279 clp->cl_time = 0; 280 } 281 282 static inline bool 283 is_client_expired(struct nfs4_client *clp) 284 { 285 return clp->cl_time == 0; 286 } 287 288 /* struct nfs4_client_reset 289 * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl 290 * upon lease reset, or from upcall to state_daemon (to read in state 291 * from non-volitile storage) upon reboot. 292 */ 293 struct nfs4_client_reclaim { 294 struct list_head cr_strhash; /* hash by cr_name */ 295 char cr_recdir[HEXDIR_LEN]; /* recover dir */ 296 }; 297 298 static inline void 299 update_stateid(stateid_t *stateid) 300 { 301 stateid->si_generation++; 302 /* Wraparound recommendation from 3530bis-13 9.1.3.2: */ 303 if (stateid->si_generation == 0) 304 stateid->si_generation = 1; 305 } 306 307 /* A reasonable value for REPLAY_ISIZE was estimated as follows: 308 * The OPEN response, typically the largest, requires 309 * 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) + 310 * 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) + 311 * 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes 312 */ 313 314 #define NFSD4_REPLAY_ISIZE 112 315 316 /* 317 * Replay buffer, where the result of the last seqid-mutating operation 318 * is cached. 319 */ 320 struct nfs4_replay { 321 __be32 rp_status; 322 unsigned int rp_buflen; 323 char *rp_buf; 324 struct knfsd_fh rp_openfh; 325 char rp_ibuf[NFSD4_REPLAY_ISIZE]; 326 }; 327 328 struct nfs4_stateowner { 329 struct list_head so_strhash; /* hash by op_name */ 330 struct list_head so_stateids; 331 struct nfs4_client * so_client; 332 /* after increment in ENCODE_SEQID_OP_TAIL, represents the next 333 * sequence id expected from the client: */ 334 u32 so_seqid; 335 struct xdr_netobj so_owner; /* open owner name */ 336 struct nfs4_replay so_replay; 337 bool so_is_open_owner; 338 }; 339 340 struct nfs4_openowner { 341 struct nfs4_stateowner oo_owner; /* must be first field */ 342 struct list_head oo_perclient; 343 /* 344 * We keep around openowners a little while after last close, 345 * which saves clients from having to confirm, and allows us to 346 * handle close replays if they come soon enough. The close_lru 347 * is a list of such openowners, to be reaped by the laundromat 348 * thread eventually if they remain unused: 349 */ 350 struct list_head oo_close_lru; 351 struct nfs4_ol_stateid *oo_last_closed_stid; 352 time_t oo_time; /* time of placement on so_close_lru */ 353 #define NFS4_OO_CONFIRMED 1 354 #define NFS4_OO_PURGE_CLOSE 2 355 #define NFS4_OO_NEW 4 356 unsigned char oo_flags; 357 }; 358 359 struct nfs4_lockowner { 360 struct nfs4_stateowner lo_owner; /* must be first element */ 361 struct list_head lo_owner_ino_hash; /* hash by owner,file */ 362 struct list_head lo_perstateid; /* for lockowners only */ 363 struct list_head lo_list; /* for temporary uses */ 364 }; 365 366 static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so) 367 { 368 return container_of(so, struct nfs4_openowner, oo_owner); 369 } 370 371 static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so) 372 { 373 return container_of(so, struct nfs4_lockowner, lo_owner); 374 } 375 376 /* nfs4_file: a file opened by some number of (open) nfs4_stateowners. */ 377 struct nfs4_file { 378 atomic_t fi_ref; 379 struct list_head fi_hash; /* hash by "struct inode *" */ 380 struct list_head fi_stateids; 381 struct list_head fi_delegations; 382 /* One each for O_RDONLY, O_WRONLY, O_RDWR: */ 383 struct file * fi_fds[3]; 384 /* 385 * Each open or lock stateid contributes 0-4 to the counts 386 * below depending on which bits are set in st_access_bitmap: 387 * 1 to fi_access[O_RDONLY] if NFS4_SHARE_ACCES_READ is set 388 * + 1 to fi_access[O_WRONLY] if NFS4_SHARE_ACCESS_WRITE is set 389 * + 1 to both of the above if NFS4_SHARE_ACCESS_BOTH is set. 390 */ 391 atomic_t fi_access[2]; 392 struct file *fi_deleg_file; 393 struct file_lock *fi_lease; 394 atomic_t fi_delegees; 395 struct inode *fi_inode; 396 bool fi_had_conflict; 397 }; 398 399 /* XXX: for first cut may fall back on returning file that doesn't work 400 * at all? */ 401 static inline struct file *find_writeable_file(struct nfs4_file *f) 402 { 403 if (f->fi_fds[O_WRONLY]) 404 return f->fi_fds[O_WRONLY]; 405 return f->fi_fds[O_RDWR]; 406 } 407 408 static inline struct file *find_readable_file(struct nfs4_file *f) 409 { 410 if (f->fi_fds[O_RDONLY]) 411 return f->fi_fds[O_RDONLY]; 412 return f->fi_fds[O_RDWR]; 413 } 414 415 static inline struct file *find_any_file(struct nfs4_file *f) 416 { 417 if (f->fi_fds[O_RDWR]) 418 return f->fi_fds[O_RDWR]; 419 else if (f->fi_fds[O_WRONLY]) 420 return f->fi_fds[O_WRONLY]; 421 else 422 return f->fi_fds[O_RDONLY]; 423 } 424 425 /* "ol" stands for "Open or Lock". Better suggestions welcome. */ 426 struct nfs4_ol_stateid { 427 struct nfs4_stid st_stid; /* must be first field */ 428 struct list_head st_perfile; 429 struct list_head st_perstateowner; 430 struct list_head st_lockowners; 431 struct nfs4_stateowner * st_stateowner; 432 struct nfs4_file * st_file; 433 unsigned long st_access_bmap; 434 unsigned long st_deny_bmap; 435 struct nfs4_ol_stateid * st_openstp; 436 }; 437 438 static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s) 439 { 440 return container_of(s, struct nfs4_ol_stateid, st_stid); 441 } 442 443 /* flags for preprocess_seqid_op() */ 444 #define RD_STATE 0x00000010 445 #define WR_STATE 0x00000020 446 447 struct nfsd4_compound_state; 448 struct nfsd_net; 449 450 extern __be32 nfs4_preprocess_stateid_op(struct net *net, 451 struct nfsd4_compound_state *cstate, 452 stateid_t *stateid, int flags, struct file **filp); 453 extern void nfs4_lock_state(void); 454 extern void nfs4_unlock_state(void); 455 extern int nfs4_in_grace(void); 456 extern void nfs4_release_reclaim(void); 457 extern struct nfs4_client_reclaim *nfsd4_find_reclaim_client(struct nfs4_client *crp); 458 extern __be32 nfs4_check_open_reclaim(clientid_t *clid, bool sessions); 459 extern void nfs4_free_openowner(struct nfs4_openowner *); 460 extern void nfs4_free_lockowner(struct nfs4_lockowner *); 461 extern int set_callback_cred(void); 462 extern void nfsd4_probe_callback(struct nfs4_client *clp); 463 extern void nfsd4_probe_callback_sync(struct nfs4_client *clp); 464 extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *); 465 extern void nfsd4_do_callback_rpc(struct work_struct *); 466 extern void nfsd4_cb_recall(struct nfs4_delegation *dp); 467 extern int nfsd4_create_callback_queue(void); 468 extern void nfsd4_destroy_callback_queue(void); 469 extern void nfsd4_shutdown_callback(struct nfs4_client *); 470 extern void nfs4_put_delegation(struct nfs4_delegation *dp); 471 extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname); 472 extern int nfs4_client_to_reclaim(const char *name); 473 extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id); 474 extern void release_session_client(struct nfsd4_session *); 475 extern void nfsd4_purge_closed_stateid(struct nfs4_stateowner *); 476 477 /* nfs4recover operations */ 478 extern int nfsd4_client_tracking_init(struct net *net); 479 extern void nfsd4_client_tracking_exit(struct net *net); 480 extern void nfsd4_client_record_create(struct nfs4_client *clp); 481 extern void nfsd4_client_record_remove(struct nfs4_client *clp); 482 extern int nfsd4_client_record_check(struct nfs4_client *clp); 483 extern void nfsd4_record_grace_done(struct net *net, time_t boot_time); 484 #endif /* NFSD4_STATE_H */ 485