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/refcount.h> 40 #include <linux/sunrpc/svc_xprt.h> 41 #include "nfsfh.h" 42 #include "nfsd.h" 43 44 typedef struct { 45 u32 cl_boot; 46 u32 cl_id; 47 } clientid_t; 48 49 typedef struct { 50 clientid_t so_clid; 51 u32 so_id; 52 } stateid_opaque_t; 53 54 typedef struct { 55 u32 si_generation; 56 stateid_opaque_t si_opaque; 57 } stateid_t; 58 59 typedef struct { 60 stateid_t cs_stid; 61 #define NFS4_COPY_STID 1 62 #define NFS4_COPYNOTIFY_STID 2 63 unsigned char cs_type; 64 refcount_t cs_count; 65 } copy_stateid_t; 66 67 struct nfsd4_callback { 68 struct nfs4_client *cb_clp; 69 struct rpc_message cb_msg; 70 const struct nfsd4_callback_ops *cb_ops; 71 struct work_struct cb_work; 72 int cb_seq_status; 73 int cb_status; 74 bool cb_need_restart; 75 bool cb_holds_slot; 76 }; 77 78 struct nfsd4_callback_ops { 79 void (*prepare)(struct nfsd4_callback *); 80 int (*done)(struct nfsd4_callback *, struct rpc_task *); 81 void (*release)(struct nfsd4_callback *); 82 uint32_t opcode; 83 }; 84 85 /* 86 * A core object that represents a "common" stateid. These are generally 87 * embedded within the different (more specific) stateid objects and contain 88 * fields that are of general use to any stateid. 89 */ 90 struct nfs4_stid { 91 refcount_t sc_count; 92 93 /* A new stateid is added to the cl_stateids idr early before it 94 * is fully initialised. Its sc_type is then zero. After 95 * initialisation the sc_type it set under cl_lock, and then 96 * never changes. 97 */ 98 #define SC_TYPE_OPEN BIT(0) 99 #define SC_TYPE_LOCK BIT(1) 100 #define SC_TYPE_DELEG BIT(2) 101 #define SC_TYPE_LAYOUT BIT(3) 102 unsigned short sc_type; 103 104 /* state_lock protects sc_status for delegation stateids. 105 * ->cl_lock protects sc_status for open and lock stateids. 106 * ->st_mutex also protect sc_status for open stateids. 107 * ->ls_lock protects sc_status for layout stateids. 108 */ 109 /* 110 * For an open stateid kept around *only* to process close replays. 111 * For deleg stateid, kept in idr until last reference is dropped. 112 */ 113 #define SC_STATUS_CLOSED BIT(0) 114 /* For a deleg stateid kept around only to process free_stateid's: */ 115 #define SC_STATUS_REVOKED BIT(1) 116 #define SC_STATUS_ADMIN_REVOKED BIT(2) 117 #define SC_STATUS_FREEABLE BIT(3) 118 #define SC_STATUS_FREED BIT(4) 119 unsigned short sc_status; 120 121 struct list_head sc_cp_list; 122 stateid_t sc_stateid; 123 spinlock_t sc_lock; 124 struct nfs4_client *sc_client; 125 struct nfs4_file *sc_file; 126 void (*sc_free)(struct nfs4_stid *); 127 }; 128 129 /* Keep a list of stateids issued by the COPY_NOTIFY, associate it with the 130 * parent OPEN/LOCK/DELEG stateid. 131 */ 132 struct nfs4_cpntf_state { 133 copy_stateid_t cp_stateid; 134 struct list_head cp_list; /* per parent nfs4_stid */ 135 stateid_t cp_p_stateid; /* copy of parent's stateid */ 136 clientid_t cp_p_clid; /* copy of parent's clid */ 137 time64_t cpntf_time; /* last time stateid used */ 138 }; 139 140 struct nfs4_cb_fattr { 141 struct nfsd4_callback ncf_getattr; 142 u32 ncf_cb_status; 143 144 /* from CB_GETATTR reply */ 145 u64 ncf_cb_change; 146 u64 ncf_cb_fsize; 147 148 unsigned long ncf_cb_flags; 149 bool ncf_file_modified; 150 u64 ncf_initial_cinfo; 151 u64 ncf_cur_fsize; 152 }; 153 154 /* bits for ncf_cb_flags */ 155 #define CB_GETATTR_BUSY 0 156 157 /* 158 * Represents a delegation stateid. The nfs4_client holds references to these 159 * and they are put when it is being destroyed or when the delegation is 160 * returned by the client: 161 * 162 * o 1 reference as long as a delegation is still in force (taken when it's 163 * alloc'd, put when it's returned or revoked) 164 * 165 * o 1 reference as long as a recall rpc is in progress (taken when the lease 166 * is broken, put when the rpc exits) 167 * 168 * o 1 more ephemeral reference for each nfsd thread currently doing something 169 * with that delegation without holding the cl_lock 170 * 171 * If the server attempts to recall a delegation and the client doesn't do so 172 * before a timeout, the server may also revoke the delegation. In that case, 173 * the object will either be destroyed (v4.0) or moved to a per-client list of 174 * revoked delegations (v4.1+). 175 * 176 * This object is a superset of the nfs4_stid. 177 */ 178 struct nfs4_delegation { 179 struct nfs4_stid dl_stid; /* must be first field */ 180 struct list_head dl_perfile; 181 struct list_head dl_perclnt; 182 struct list_head dl_recall_lru; /* delegation recalled */ 183 struct nfs4_clnt_odstate *dl_clnt_odstate; 184 u32 dl_type; 185 time64_t dl_time; 186 /* For recall: */ 187 int dl_retries; 188 struct nfsd4_callback dl_recall; 189 bool dl_recalled; 190 191 /* for CB_GETATTR */ 192 struct nfs4_cb_fattr dl_cb_fattr; 193 }; 194 195 #define cb_to_delegation(cb) \ 196 container_of(cb, struct nfs4_delegation, dl_recall) 197 198 /* client delegation callback info */ 199 struct nfs4_cb_conn { 200 /* SETCLIENTID info */ 201 struct sockaddr_storage cb_addr; 202 struct sockaddr_storage cb_saddr; 203 size_t cb_addrlen; 204 u32 cb_prog; /* used only in 4.0 case; 205 per-session otherwise */ 206 u32 cb_ident; /* minorversion 0 only */ 207 struct svc_xprt *cb_xprt; /* minorversion 1 only */ 208 }; 209 210 static inline struct nfs4_delegation *delegstateid(struct nfs4_stid *s) 211 { 212 return container_of(s, struct nfs4_delegation, dl_stid); 213 } 214 215 /* Maximum number of slots per session. 160 is useful for long haul TCP */ 216 #define NFSD_MAX_SLOTS_PER_SESSION 160 217 /* Maximum session per slot cache size */ 218 #define NFSD_SLOT_CACHE_SIZE 2048 219 /* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */ 220 #define NFSD_CACHE_SIZE_SLOTS_PER_SESSION 32 221 #define NFSD_MAX_MEM_PER_SESSION \ 222 (NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE) 223 224 struct nfsd4_slot { 225 u32 sl_seqid; 226 __be32 sl_status; 227 struct svc_cred sl_cred; 228 u32 sl_datalen; 229 u16 sl_opcnt; 230 #define NFSD4_SLOT_INUSE (1 << 0) 231 #define NFSD4_SLOT_CACHETHIS (1 << 1) 232 #define NFSD4_SLOT_INITIALIZED (1 << 2) 233 #define NFSD4_SLOT_CACHED (1 << 3) 234 u8 sl_flags; 235 char sl_data[]; 236 }; 237 238 struct nfsd4_channel_attrs { 239 u32 headerpadsz; 240 u32 maxreq_sz; 241 u32 maxresp_sz; 242 u32 maxresp_cached; 243 u32 maxops; 244 u32 maxreqs; 245 u32 nr_rdma_attrs; 246 u32 rdma_attrs; 247 }; 248 249 struct nfsd4_cb_sec { 250 u32 flavor; /* (u32)(-1) used to mean "no valid flavor" */ 251 kuid_t uid; 252 kgid_t gid; 253 }; 254 255 struct nfsd4_create_session { 256 clientid_t clientid; 257 struct nfs4_sessionid sessionid; 258 u32 seqid; 259 u32 flags; 260 struct nfsd4_channel_attrs fore_channel; 261 struct nfsd4_channel_attrs back_channel; 262 u32 callback_prog; 263 struct nfsd4_cb_sec cb_sec; 264 }; 265 266 struct nfsd4_backchannel_ctl { 267 u32 bc_cb_program; 268 struct nfsd4_cb_sec bc_cb_sec; 269 }; 270 271 struct nfsd4_bind_conn_to_session { 272 struct nfs4_sessionid sessionid; 273 u32 dir; 274 }; 275 276 /* The single slot clientid cache structure */ 277 struct nfsd4_clid_slot { 278 u32 sl_seqid; 279 __be32 sl_status; 280 struct nfsd4_create_session sl_cr_ses; 281 }; 282 283 struct nfsd4_conn { 284 struct list_head cn_persession; 285 struct svc_xprt *cn_xprt; 286 struct svc_xpt_user cn_xpt_user; 287 struct nfsd4_session *cn_session; 288 /* CDFC4_FORE, CDFC4_BACK: */ 289 unsigned char cn_flags; 290 }; 291 292 /* 293 * Representation of a v4.1+ session. These are refcounted in a similar fashion 294 * to the nfs4_client. References are only taken when the server is actively 295 * working on the object (primarily during the processing of compounds). 296 */ 297 struct nfsd4_session { 298 atomic_t se_ref; 299 struct list_head se_hash; /* hash by sessionid */ 300 struct list_head se_perclnt; 301 /* See SESSION4_PERSIST, etc. for standard flags; this is internal-only: */ 302 #define NFS4_SESSION_DEAD 0x010 303 u32 se_flags; 304 struct nfs4_client *se_client; 305 struct nfs4_sessionid se_sessionid; 306 struct nfsd4_channel_attrs se_fchannel; 307 struct nfsd4_channel_attrs se_bchannel; 308 struct nfsd4_cb_sec se_cb_sec; 309 struct list_head se_conns; 310 u32 se_cb_prog; 311 u32 se_cb_seq_nr; 312 struct nfsd4_slot *se_slots[]; /* forward channel slots */ 313 }; 314 315 /* formatted contents of nfs4_sessionid */ 316 struct nfsd4_sessionid { 317 clientid_t clientid; 318 u32 sequence; 319 u32 reserved; 320 }; 321 322 #define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */ 323 324 /* 325 * State Meaning Where set 326 * -------------------------------------------------------------------------- 327 * | NFSD4_ACTIVE | Confirmed, active | Default | 328 * |------------------- ----------------------------------------------------| 329 * | NFSD4_COURTESY | Courtesy state. | nfs4_get_client_reaplist | 330 * | | Lease/lock/share | | 331 * | | reservation conflict | | 332 * | | can cause Courtesy | | 333 * | | client to be expired | | 334 * |------------------------------------------------------------------------| 335 * | NFSD4_EXPIRABLE | Courtesy client to be| nfs4_laundromat | 336 * | | expired by Laundromat| try_to_expire_client | 337 * | | due to conflict | | 338 * |------------------------------------------------------------------------| 339 */ 340 enum { 341 NFSD4_ACTIVE = 0, 342 NFSD4_COURTESY, 343 NFSD4_EXPIRABLE, 344 }; 345 346 /* 347 * struct nfs4_client - one per client. Clientids live here. 348 * 349 * The initial object created by an NFS client using SETCLIENTID (for NFSv4.0) 350 * or EXCHANGE_ID (for NFSv4.1+). These objects are refcounted and timestamped. 351 * Each nfsd_net_ns object contains a set of these and they are tracked via 352 * short and long form clientid. They are hashed and searched for under the 353 * per-nfsd_net client_lock spinlock. 354 * 355 * References to it are only held during the processing of compounds, and in 356 * certain other operations. In their "resting state" they have a refcount of 357 * 0. If they are not renewed within a lease period, they become eligible for 358 * destruction by the laundromat. 359 * 360 * These objects can also be destroyed if the client sends certain forms of 361 * SETCLIENTID or EXCHANGE_ID operations. 362 * 363 * Care is taken *not* to do this however when the objects have an elevated 364 * refcount. 365 * 366 * o Each nfs4_client is hashed by clientid 367 * 368 * o Each nfs4_clients is also hashed by name (the opaque quantity initially 369 * sent by the client to identify itself). 370 * 371 * o cl_perclient list is used to ensure no dangling stateowner references 372 * when we expire the nfs4_client 373 */ 374 struct nfs4_client { 375 struct list_head cl_idhash; /* hash by cl_clientid.id */ 376 struct rb_node cl_namenode; /* link into by-name trees */ 377 struct list_head *cl_ownerstr_hashtbl; 378 struct list_head cl_openowners; 379 struct idr cl_stateids; /* stateid lookup */ 380 struct list_head cl_delegations; 381 struct list_head cl_revoked; /* unacknowledged, revoked 4.1 state */ 382 struct list_head cl_lru; /* tail queue */ 383 #ifdef CONFIG_NFSD_PNFS 384 struct list_head cl_lo_states; /* outstanding layout states */ 385 #endif 386 struct xdr_netobj cl_name; /* id generated by client */ 387 nfs4_verifier cl_verifier; /* generated by client */ 388 time64_t cl_time; /* time of last lease renewal */ 389 struct sockaddr_storage cl_addr; /* client ipaddress */ 390 bool cl_mach_cred; /* SP4_MACH_CRED in force */ 391 struct svc_cred cl_cred; /* setclientid principal */ 392 clientid_t cl_clientid; /* generated by server */ 393 nfs4_verifier cl_confirm; /* generated by server */ 394 u32 cl_minorversion; 395 atomic_t cl_admin_revoked; /* count of admin-revoked states */ 396 /* NFSv4.1 client implementation id: */ 397 struct xdr_netobj cl_nii_domain; 398 struct xdr_netobj cl_nii_name; 399 struct timespec64 cl_nii_time; 400 401 /* for v4.0 and v4.1 callbacks: */ 402 struct nfs4_cb_conn cl_cb_conn; 403 #define NFSD4_CLIENT_CB_UPDATE (0) 404 #define NFSD4_CLIENT_CB_KILL (1) 405 #define NFSD4_CLIENT_STABLE (2) /* client on stable storage */ 406 #define NFSD4_CLIENT_RECLAIM_COMPLETE (3) /* reclaim_complete done */ 407 #define NFSD4_CLIENT_CONFIRMED (4) /* client is confirmed */ 408 #define NFSD4_CLIENT_UPCALL_LOCK (5) /* upcall serialization */ 409 #define NFSD4_CLIENT_CB_FLAG_MASK (1 << NFSD4_CLIENT_CB_UPDATE | \ 410 1 << NFSD4_CLIENT_CB_KILL) 411 #define NFSD4_CLIENT_CB_RECALL_ANY (6) 412 unsigned long cl_flags; 413 414 struct workqueue_struct *cl_callback_wq; 415 const struct cred *cl_cb_cred; 416 struct rpc_clnt *cl_cb_client; 417 u32 cl_cb_ident; 418 #define NFSD4_CB_UP 0 419 #define NFSD4_CB_UNKNOWN 1 420 #define NFSD4_CB_DOWN 2 421 #define NFSD4_CB_FAULT 3 422 int cl_cb_state; 423 struct nfsd4_callback cl_cb_null; 424 struct nfsd4_session *cl_cb_session; 425 426 /* for all client information that callback code might need: */ 427 spinlock_t cl_lock; 428 429 /* for nfs41 */ 430 struct list_head cl_sessions; 431 struct nfsd4_clid_slot cl_cs_slot; /* create_session slot */ 432 u32 cl_exchange_flags; 433 /* number of rpc's in progress over an associated session: */ 434 atomic_t cl_rpc_users; 435 struct nfsdfs_client cl_nfsdfs; 436 struct nfs4_op_map cl_spo_must_allow; 437 438 /* debugging info directory under nfsd/clients/ : */ 439 struct dentry *cl_nfsd_dentry; 440 /* 'info' file within that directory. Ref is not counted, 441 * but will remain valid iff cl_nfsd_dentry != NULL 442 */ 443 struct dentry *cl_nfsd_info_dentry; 444 445 /* for nfs41 callbacks */ 446 /* We currently support a single back channel with a single slot */ 447 unsigned long cl_cb_slot_busy; 448 struct rpc_wait_queue cl_cb_waitq; /* backchannel callers may */ 449 /* wait here for slots */ 450 struct net *net; 451 struct list_head async_copies; /* list of async copies */ 452 spinlock_t async_lock; /* lock for async copies */ 453 atomic_t cl_cb_inflight; /* Outstanding callbacks */ 454 455 unsigned int cl_state; 456 atomic_t cl_delegs_in_recall; 457 458 struct nfsd4_cb_recall_any *cl_ra; 459 time64_t cl_ra_time; 460 struct list_head cl_ra_cblist; 461 }; 462 463 /* struct nfs4_client_reset 464 * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl 465 * upon lease reset, or from upcall to state_daemon (to read in state 466 * from non-volitile storage) upon reboot. 467 */ 468 struct nfs4_client_reclaim { 469 struct list_head cr_strhash; /* hash by cr_name */ 470 struct nfs4_client *cr_clp; /* pointer to associated clp */ 471 struct xdr_netobj cr_name; /* recovery dir name */ 472 struct xdr_netobj cr_princhash; 473 }; 474 475 /* A reasonable value for REPLAY_ISIZE was estimated as follows: 476 * The OPEN response, typically the largest, requires 477 * 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) + 478 * 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) + 479 * 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes 480 */ 481 482 #define NFSD4_REPLAY_ISIZE 112 483 484 /* 485 * Replay buffer, where the result of the last seqid-mutating operation 486 * is cached. 487 */ 488 struct nfs4_replay { 489 __be32 rp_status; 490 unsigned int rp_buflen; 491 char *rp_buf; 492 struct knfsd_fh rp_openfh; 493 atomic_t rp_locked; 494 char rp_ibuf[NFSD4_REPLAY_ISIZE]; 495 }; 496 497 struct nfs4_stateowner; 498 499 struct nfs4_stateowner_operations { 500 void (*so_unhash)(struct nfs4_stateowner *); 501 void (*so_free)(struct nfs4_stateowner *); 502 }; 503 504 /* 505 * A core object that represents either an open or lock owner. The object and 506 * lock owner objects have one of these embedded within them. Refcounts and 507 * other fields common to both owner types are contained within these 508 * structures. 509 */ 510 struct nfs4_stateowner { 511 struct list_head so_strhash; 512 struct list_head so_stateids; 513 struct nfs4_client *so_client; 514 const struct nfs4_stateowner_operations *so_ops; 515 /* after increment in nfsd4_bump_seqid, represents the next 516 * sequence id expected from the client: */ 517 atomic_t so_count; 518 u32 so_seqid; 519 struct xdr_netobj so_owner; /* open owner name */ 520 struct nfs4_replay so_replay; 521 bool so_is_open_owner; 522 }; 523 524 /* 525 * When a file is opened, the client provides an open state owner opaque string 526 * that indicates the "owner" of that open. These objects are refcounted. 527 * References to it are held by each open state associated with it. This object 528 * is a superset of the nfs4_stateowner struct. 529 */ 530 struct nfs4_openowner { 531 struct nfs4_stateowner oo_owner; /* must be first field */ 532 struct list_head oo_perclient; 533 /* 534 * We keep around openowners a little while after last close, 535 * which saves clients from having to confirm, and allows us to 536 * handle close replays if they come soon enough. The close_lru 537 * is a list of such openowners, to be reaped by the laundromat 538 * thread eventually if they remain unused: 539 */ 540 struct list_head oo_close_lru; 541 struct nfs4_ol_stateid *oo_last_closed_stid; 542 time64_t oo_time; /* time of placement on so_close_lru */ 543 #define NFS4_OO_CONFIRMED 1 544 unsigned char oo_flags; 545 }; 546 547 /* 548 * Represents a generic "lockowner". Similar to an openowner. References to it 549 * are held by the lock stateids that are created on its behalf. This object is 550 * a superset of the nfs4_stateowner struct. 551 */ 552 struct nfs4_lockowner { 553 struct nfs4_stateowner lo_owner; /* must be first element */ 554 struct list_head lo_blocked; /* blocked file_locks */ 555 }; 556 557 static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so) 558 { 559 return container_of(so, struct nfs4_openowner, oo_owner); 560 } 561 562 static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so) 563 { 564 return container_of(so, struct nfs4_lockowner, lo_owner); 565 } 566 567 /* 568 * Per-client state indicating no. of opens and outstanding delegations 569 * on a file from a particular client.'od' stands for 'open & delegation' 570 */ 571 struct nfs4_clnt_odstate { 572 struct nfs4_client *co_client; 573 struct nfs4_file *co_file; 574 struct list_head co_perfile; 575 refcount_t co_odcount; 576 }; 577 578 /* 579 * nfs4_file: a file opened by some number of (open) nfs4_stateowners. 580 * 581 * These objects are global. nfsd keeps one instance of a nfs4_file per 582 * filehandle (though it may keep multiple file descriptors for each). Each 583 * inode can have multiple filehandles associated with it, so there is 584 * (potentially) a many to one relationship between this struct and struct 585 * inode. 586 */ 587 struct nfs4_file { 588 refcount_t fi_ref; 589 struct inode * fi_inode; 590 bool fi_aliased; 591 spinlock_t fi_lock; 592 struct rhlist_head fi_rlist; 593 struct list_head fi_stateids; 594 union { 595 struct list_head fi_delegations; 596 struct rcu_head fi_rcu; 597 }; 598 struct list_head fi_clnt_odstate; 599 /* One each for O_RDONLY, O_WRONLY, O_RDWR: */ 600 struct nfsd_file *fi_fds[3]; 601 /* 602 * Each open or lock stateid contributes 0-4 to the counts 603 * below depending on which bits are set in st_access_bitmap: 604 * 1 to fi_access[O_RDONLY] if NFS4_SHARE_ACCES_READ is set 605 * + 1 to fi_access[O_WRONLY] if NFS4_SHARE_ACCESS_WRITE is set 606 * + 1 to both of the above if NFS4_SHARE_ACCESS_BOTH is set. 607 */ 608 atomic_t fi_access[2]; 609 u32 fi_share_deny; 610 struct nfsd_file *fi_deleg_file; 611 int fi_delegees; 612 struct knfsd_fh fi_fhandle; 613 bool fi_had_conflict; 614 #ifdef CONFIG_NFSD_PNFS 615 struct list_head fi_lo_states; 616 atomic_t fi_lo_recalls; 617 #endif 618 }; 619 620 /* 621 * A generic struct representing either a open or lock stateid. The nfs4_client 622 * holds a reference to each of these objects, and they in turn hold a 623 * reference to their respective stateowners. The client's reference is 624 * released in response to a close or unlock (depending on whether it's an open 625 * or lock stateid) or when the client is being destroyed. 626 * 627 * In the case of v4.0 open stateids, these objects are preserved for a little 628 * while after close in order to handle CLOSE replays. Those are eventually 629 * reclaimed via a LRU scheme by the laundromat. 630 * 631 * This object is a superset of the nfs4_stid. "ol" stands for "Open or Lock". 632 * Better suggestions welcome. 633 */ 634 struct nfs4_ol_stateid { 635 struct nfs4_stid st_stid; 636 struct list_head st_perfile; 637 struct list_head st_perstateowner; 638 struct list_head st_locks; 639 struct nfs4_stateowner *st_stateowner; 640 struct nfs4_clnt_odstate *st_clnt_odstate; 641 /* 642 * These bitmasks use 3 separate bits for READ, ALLOW, and BOTH; see the 643 * comment above bmap_to_share_mode() for explanation: 644 */ 645 unsigned char st_access_bmap; 646 unsigned char st_deny_bmap; 647 struct nfs4_ol_stateid *st_openstp; 648 struct mutex st_mutex; 649 }; 650 651 static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s) 652 { 653 return container_of(s, struct nfs4_ol_stateid, st_stid); 654 } 655 656 struct nfs4_layout_stateid { 657 struct nfs4_stid ls_stid; 658 struct list_head ls_perclnt; 659 struct list_head ls_perfile; 660 spinlock_t ls_lock; 661 struct list_head ls_layouts; 662 u32 ls_layout_type; 663 struct nfsd_file *ls_file; 664 struct nfsd4_callback ls_recall; 665 stateid_t ls_recall_sid; 666 bool ls_recalled; 667 struct mutex ls_mutex; 668 }; 669 670 static inline struct nfs4_layout_stateid *layoutstateid(struct nfs4_stid *s) 671 { 672 return container_of(s, struct nfs4_layout_stateid, ls_stid); 673 } 674 675 /* flags for preprocess_seqid_op() */ 676 #define RD_STATE 0x00000010 677 #define WR_STATE 0x00000020 678 679 enum nfsd4_cb_op { 680 NFSPROC4_CLNT_CB_NULL = 0, 681 NFSPROC4_CLNT_CB_RECALL, 682 NFSPROC4_CLNT_CB_LAYOUT, 683 NFSPROC4_CLNT_CB_OFFLOAD, 684 NFSPROC4_CLNT_CB_SEQUENCE, 685 NFSPROC4_CLNT_CB_NOTIFY_LOCK, 686 NFSPROC4_CLNT_CB_RECALL_ANY, 687 NFSPROC4_CLNT_CB_GETATTR, 688 }; 689 690 /* Returns true iff a is later than b: */ 691 static inline bool nfsd4_stateid_generation_after(stateid_t *a, stateid_t *b) 692 { 693 return (s32)(a->si_generation - b->si_generation) > 0; 694 } 695 696 /* 697 * When a client tries to get a lock on a file, we set one of these objects 698 * on the blocking lock. When the lock becomes free, we can then issue a 699 * CB_NOTIFY_LOCK to the server. 700 */ 701 struct nfsd4_blocked_lock { 702 struct list_head nbl_list; 703 struct list_head nbl_lru; 704 time64_t nbl_time; 705 struct file_lock nbl_lock; 706 struct knfsd_fh nbl_fh; 707 struct nfsd4_callback nbl_cb; 708 struct kref nbl_kref; 709 }; 710 711 struct nfsd4_compound_state; 712 struct nfsd_net; 713 struct nfsd4_copy; 714 715 extern __be32 nfs4_preprocess_stateid_op(struct svc_rqst *rqstp, 716 struct nfsd4_compound_state *cstate, struct svc_fh *fhp, 717 stateid_t *stateid, int flags, struct nfsd_file **filp, 718 struct nfs4_stid **cstid); 719 __be32 nfsd4_lookup_stateid(struct nfsd4_compound_state *cstate, 720 stateid_t *stateid, unsigned short typemask, 721 unsigned short statusmask, 722 struct nfs4_stid **s, struct nfsd_net *nn); 723 struct nfs4_stid *nfs4_alloc_stid(struct nfs4_client *cl, struct kmem_cache *slab, 724 void (*sc_free)(struct nfs4_stid *)); 725 int nfs4_init_copy_state(struct nfsd_net *nn, struct nfsd4_copy *copy); 726 void nfs4_free_copy_state(struct nfsd4_copy *copy); 727 struct nfs4_cpntf_state *nfs4_alloc_init_cpntf_state(struct nfsd_net *nn, 728 struct nfs4_stid *p_stid); 729 void nfs4_put_stid(struct nfs4_stid *s); 730 void nfs4_inc_and_copy_stateid(stateid_t *dst, struct nfs4_stid *stid); 731 void nfs4_remove_reclaim_record(struct nfs4_client_reclaim *, struct nfsd_net *); 732 extern void nfs4_release_reclaim(struct nfsd_net *); 733 extern struct nfs4_client_reclaim *nfsd4_find_reclaim_client(struct xdr_netobj name, 734 struct nfsd_net *nn); 735 extern __be32 nfs4_check_open_reclaim(struct nfs4_client *); 736 extern void nfsd4_probe_callback(struct nfs4_client *clp); 737 extern void nfsd4_probe_callback_sync(struct nfs4_client *clp); 738 extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *); 739 extern void nfsd4_init_cb(struct nfsd4_callback *cb, struct nfs4_client *clp, 740 const struct nfsd4_callback_ops *ops, enum nfsd4_cb_op op); 741 extern bool nfsd4_run_cb(struct nfsd4_callback *cb); 742 extern void nfsd4_shutdown_callback(struct nfs4_client *); 743 extern void nfsd4_shutdown_copy(struct nfs4_client *clp); 744 extern struct nfs4_client_reclaim *nfs4_client_to_reclaim(struct xdr_netobj name, 745 struct xdr_netobj princhash, struct nfsd_net *nn); 746 extern bool nfs4_has_reclaimed_state(struct xdr_netobj name, struct nfsd_net *nn); 747 748 void put_nfs4_file(struct nfs4_file *fi); 749 extern void nfs4_put_cpntf_state(struct nfsd_net *nn, 750 struct nfs4_cpntf_state *cps); 751 extern __be32 manage_cpntf_state(struct nfsd_net *nn, stateid_t *st, 752 struct nfs4_client *clp, 753 struct nfs4_cpntf_state **cps); 754 static inline void get_nfs4_file(struct nfs4_file *fi) 755 { 756 refcount_inc(&fi->fi_ref); 757 } 758 struct nfsd_file *find_any_file(struct nfs4_file *f); 759 760 #ifdef CONFIG_NFSD_V4 761 void nfsd4_revoke_states(struct net *net, struct super_block *sb); 762 #else 763 static inline void nfsd4_revoke_states(struct net *net, struct super_block *sb) 764 { 765 } 766 #endif 767 768 /* grace period management */ 769 void nfsd4_end_grace(struct nfsd_net *nn); 770 771 /* nfs4recover operations */ 772 extern int nfsd4_client_tracking_init(struct net *net); 773 extern void nfsd4_client_tracking_exit(struct net *net); 774 extern void nfsd4_client_record_create(struct nfs4_client *clp); 775 extern void nfsd4_client_record_remove(struct nfs4_client *clp); 776 extern int nfsd4_client_record_check(struct nfs4_client *clp); 777 extern void nfsd4_record_grace_done(struct nfsd_net *nn); 778 779 static inline bool try_to_expire_client(struct nfs4_client *clp) 780 { 781 cmpxchg(&clp->cl_state, NFSD4_COURTESY, NFSD4_EXPIRABLE); 782 return clp->cl_state == NFSD4_EXPIRABLE; 783 } 784 785 extern __be32 nfsd4_deleg_getattr_conflict(struct svc_rqst *rqstp, 786 struct dentry *dentry, struct nfs4_delegation **pdp); 787 #endif /* NFSD4_STATE_H */ 788