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