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