fs/nfsd/state.h

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