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/sunrpc/svc_xprt.h>
  40 #include "nfsfh.h"
  41
  42 typedef struct {
  43         u32             cl_boot;
  44         u32             cl_id;
  45 } clientid_t;
  46
  47 typedef struct {
  48         clientid_t      so_clid;
  49         u32             so_id;
  50 } stateid_opaque_t;
  51
  52 typedef struct {
  53         u32                     si_generation;
  54         stateid_opaque_t        si_opaque;
  55 } stateid_t;
  56
  57 #define STATEID_FMT     "(%08x/%08x/%08x/%08x)"
  58 #define STATEID_VAL(s) \
  59         (s)->si_opaque.so_clid.cl_boot, \
  60         (s)->si_opaque.so_clid.cl_id, \
  61         (s)->si_opaque.so_id, \
  62         (s)->si_generation
  63
  64 struct nfsd4_callback {
  65         void *cb_op;
  66         struct nfs4_client *cb_clp;
  67         struct list_head cb_per_client;
  68         u32 cb_minorversion;
  69         struct rpc_message cb_msg;
  70         const struct rpc_call_ops *cb_ops;
  71         struct work_struct cb_work;
  72         bool cb_done;
  73 };
  74
  75 struct nfs4_stid {
  76 #define NFS4_OPEN_STID 1
  77 #define NFS4_LOCK_STID 2
  78 #define NFS4_DELEG_STID 4
  79 /* For an open stateid kept around *only* to process close replays: */
  80 #define NFS4_CLOSED_STID 8
  81 /* For a deleg stateid kept around only to process free_stateid's: */
  82 #define NFS4_REVOKED_DELEG_STID 16
  83         unsigned char sc_type;
  84         stateid_t sc_stateid;
  85         struct nfs4_client *sc_client;
  86 };
  87
  88 struct nfs4_delegation {
  89         struct nfs4_stid        dl_stid; /* must be first field */
  90         struct list_head        dl_perfile;
  91         struct list_head        dl_perclnt;
  92         struct list_head        dl_recall_lru;  /* delegation recalled */
  93         atomic_t                dl_count;       /* ref count */
  94         struct nfs4_file        *dl_file;
  95         u32                     dl_type;
  96         time_t                  dl_time;
  97 /* For recall: */
  98         struct knfsd_fh         dl_fh;
  99         int                     dl_retries;
 100         struct nfsd4_callback   dl_recall;
 101 };
 102
 103 /* client delegation callback info */
 104 struct nfs4_cb_conn {
 105         /* SETCLIENTID info */
 106         struct sockaddr_storage cb_addr;
 107         struct sockaddr_storage cb_saddr;
 108         size_t                  cb_addrlen;
 109         u32                     cb_prog; /* used only in 4.0 case;
 110                                             per-session otherwise */
 111         u32                     cb_ident;       /* minorversion 0 only */
 112         struct svc_xprt         *cb_xprt;       /* minorversion 1 only */
 113 };
 114
 115 static inline struct nfs4_delegation *delegstateid(struct nfs4_stid *s)
 116 {
 117         return container_of(s, struct nfs4_delegation, dl_stid);
 118 }
 119
 120 /* Maximum number of slots per session. 160 is useful for long haul TCP */
 121 #define NFSD_MAX_SLOTS_PER_SESSION     160
 122 /* Maximum number of operations per session compound */
 123 #define NFSD_MAX_OPS_PER_COMPOUND       16
 124 /* Maximum  session per slot cache size */
 125 #define NFSD_SLOT_CACHE_SIZE            2048
 126 /* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
 127 #define NFSD_CACHE_SIZE_SLOTS_PER_SESSION       32
 128 #define NFSD_MAX_MEM_PER_SESSION  \
 129                 (NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
 130
 131 struct nfsd4_slot {
 132         u32     sl_seqid;
 133         __be32  sl_status;
 134         u32     sl_datalen;
 135         u16     sl_opcnt;
 136 #define NFSD4_SLOT_INUSE        (1 << 0)
 137 #define NFSD4_SLOT_CACHETHIS    (1 << 1)
 138 #define NFSD4_SLOT_INITIALIZED  (1 << 2)
 139         u8      sl_flags;
 140         char    sl_data[];
 141 };
 142
 143 struct nfsd4_channel_attrs {
 144         u32             headerpadsz;
 145         u32             maxreq_sz;
 146         u32             maxresp_sz;
 147         u32             maxresp_cached;
 148         u32             maxops;
 149         u32             maxreqs;
 150         u32             nr_rdma_attrs;
 151         u32             rdma_attrs;
 152 };
 153
 154 struct nfsd4_cb_sec {
 155         u32     flavor; /* (u32)(-1) used to mean "no valid flavor" */
 156         kuid_t  uid;
 157         kgid_t  gid;
 158 };
 159
 160 struct nfsd4_create_session {
 161         clientid_t                      clientid;
 162         struct nfs4_sessionid           sessionid;
 163         u32                             seqid;
 164         u32                             flags;
 165         struct nfsd4_channel_attrs      fore_channel;
 166         struct nfsd4_channel_attrs      back_channel;
 167         u32                             callback_prog;
 168         struct nfsd4_cb_sec             cb_sec;
 169 };
 170
 171 struct nfsd4_backchannel_ctl {
 172         u32     bc_cb_program;
 173         struct nfsd4_cb_sec             bc_cb_sec;
 174 };
 175
 176 struct nfsd4_bind_conn_to_session {
 177         struct nfs4_sessionid           sessionid;
 178         u32                             dir;
 179 };
 180
 181 /* The single slot clientid cache structure */
 182 struct nfsd4_clid_slot {
 183         u32                             sl_seqid;
 184         __be32                          sl_status;
 185         struct nfsd4_create_session     sl_cr_ses;
 186 };
 187
 188 struct nfsd4_conn {
 189         struct list_head cn_persession;
 190         struct svc_xprt *cn_xprt;
 191         struct svc_xpt_user cn_xpt_user;
 192         struct nfsd4_session *cn_session;
 193 /* CDFC4_FORE, CDFC4_BACK: */
 194         unsigned char cn_flags;
 195 };
 196
 197 struct nfsd4_session {
 198         atomic_t                se_ref;
 199         struct list_head        se_hash;        /* hash by sessionid */
 200         struct list_head        se_perclnt;
 201 /* See SESSION4_PERSIST, etc. for standard flags; this is internal-only: */
 202 #define NFS4_SESSION_DEAD       0x010
 203         u32                     se_flags;
 204         struct nfs4_client      *se_client;
 205         struct nfs4_sessionid   se_sessionid;
 206         struct nfsd4_channel_attrs se_fchannel;
 207         struct nfsd4_channel_attrs se_bchannel;
 208         struct nfsd4_cb_sec     se_cb_sec;
 209         struct list_head        se_conns;
 210         u32                     se_cb_prog;
 211         u32                     se_cb_seq_nr;
 212         struct nfsd4_slot       *se_slots[];    /* forward channel slots */
 213 };
 214
 215 /* formatted contents of nfs4_sessionid */
 216 struct nfsd4_sessionid {
 217         clientid_t      clientid;
 218         u32             sequence;
 219         u32             reserved;
 220 };
 221
 222 #define HEXDIR_LEN     33 /* hex version of 16 byte md5 of cl_name plus '\0' */
 223
 224 /*
 225  * struct nfs4_client - one per client.  Clientids live here.
 226  *      o Each nfs4_client is hashed by clientid.
 227  *
 228  *      o Each nfs4_clients is also hashed by name
 229  *        (the opaque quantity initially sent by the client to identify itself).
 230  *
 231  *      o cl_perclient list is used to ensure no dangling stateowner references
 232  *        when we expire the nfs4_client
 233  */
 234 struct nfs4_client {
 235         struct list_head        cl_idhash;      /* hash by cl_clientid.id */
 236         struct rb_node          cl_namenode;    /* link into by-name trees */
 237         struct list_head        cl_openowners;
 238         struct idr              cl_stateids;    /* stateid lookup */
 239         struct list_head        cl_delegations;
 240         struct list_head        cl_revoked;     /* unacknowledged, revoked 4.1 state */
 241         struct list_head        cl_lru;         /* tail queue */
 242         struct xdr_netobj       cl_name;        /* id generated by client */
 243         nfs4_verifier           cl_verifier;    /* generated by client */
 244         time_t                  cl_time;        /* time of last lease renewal */
 245         struct sockaddr_storage cl_addr;        /* client ipaddress */
 246         bool                    cl_mach_cred;   /* SP4_MACH_CRED in force */
 247         struct svc_cred         cl_cred;        /* setclientid principal */
 248         clientid_t              cl_clientid;    /* generated by server */
 249         nfs4_verifier           cl_confirm;     /* generated by server */
 250         u32                     cl_minorversion;
 251
 252         /* for v4.0 and v4.1 callbacks: */
 253         struct nfs4_cb_conn     cl_cb_conn;
 254 #define NFSD4_CLIENT_CB_UPDATE          (0)
 255 #define NFSD4_CLIENT_CB_KILL            (1)
 256 #define NFSD4_CLIENT_STABLE             (2)     /* client on stable storage */
 257 #define NFSD4_CLIENT_RECLAIM_COMPLETE   (3)     /* reclaim_complete done */
 258 #define NFSD4_CLIENT_CONFIRMED          (4)     /* client is confirmed */
 259 #define NFSD4_CLIENT_CB_FLAG_MASK       (1 << NFSD4_CLIENT_CB_UPDATE | \
 260                                          1 << NFSD4_CLIENT_CB_KILL)
 261         unsigned long           cl_flags;
 262         struct rpc_cred         *cl_cb_cred;
 263         struct rpc_clnt         *cl_cb_client;
 264         u32                     cl_cb_ident;
 265 #define NFSD4_CB_UP             0
 266 #define NFSD4_CB_UNKNOWN        1
 267 #define NFSD4_CB_DOWN           2
 268 #define NFSD4_CB_FAULT          3
 269         int                     cl_cb_state;
 270         struct nfsd4_callback   cl_cb_null;
 271         struct nfsd4_session    *cl_cb_session;
 272         struct list_head        cl_callbacks; /* list of in-progress callbacks */
 273
 274         /* for all client information that callback code might need: */
 275         spinlock_t              cl_lock;
 276
 277         /* for nfs41 */
 278         struct list_head        cl_sessions;
 279         struct nfsd4_clid_slot  cl_cs_slot;     /* create_session slot */
 280         u32                     cl_exchange_flags;
 281         /* number of rpc's in progress over an associated session: */
 282         atomic_t                cl_refcount;
 283
 284         /* for nfs41 callbacks */
 285         /* We currently support a single back channel with a single slot */
 286         unsigned long           cl_cb_slot_busy;
 287         struct rpc_wait_queue   cl_cb_waitq;    /* backchannel callers may */
 288                                                 /* wait here for slots */
 289         struct net              *net;
 290 };
 291
 292 /* struct nfs4_client_reset
 293  * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
 294  * upon lease reset, or from upcall to state_daemon (to read in state
 295  * from non-volitile storage) upon reboot.
 296  */
 297 struct nfs4_client_reclaim {
 298         struct list_head        cr_strhash;     /* hash by cr_name */
 299         struct nfs4_client      *cr_clp;        /* pointer to associated clp */
 300         char                    cr_recdir[HEXDIR_LEN]; /* recover dir */
 301 };
 302
 303 static inline void
 304 update_stateid(stateid_t *stateid)
 305 {
 306         stateid->si_generation++;
 307         /* Wraparound recommendation from 3530bis-13 9.1.3.2: */
 308         if (stateid->si_generation == 0)
 309                 stateid->si_generation = 1;
 310 }
 311
 312 /* A reasonable value for REPLAY_ISIZE was estimated as follows:
 313  * The OPEN response, typically the largest, requires
 314  *   4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) +  8(verifier) +
 315  *   4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
 316  *   20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
 317  */
 318
 319 #define NFSD4_REPLAY_ISIZE       112
 320
 321 /*
 322  * Replay buffer, where the result of the last seqid-mutating operation
 323  * is cached.
 324  */
 325 struct nfs4_replay {
 326         __be32                  rp_status;
 327         unsigned int            rp_buflen;
 328         char                    *rp_buf;
 329         struct knfsd_fh         rp_openfh;
 330         char                    rp_ibuf[NFSD4_REPLAY_ISIZE];
 331 };
 332
 333 struct nfs4_stateowner {
 334         struct list_head        so_strhash;   /* hash by op_name */
 335         struct list_head        so_stateids;
 336         struct nfs4_client *    so_client;
 337         /* after increment in ENCODE_SEQID_OP_TAIL, represents the next
 338          * sequence id expected from the client: */
 339         u32                     so_seqid;
 340         struct xdr_netobj       so_owner;     /* open owner name */
 341         struct nfs4_replay      so_replay;
 342         bool                    so_is_open_owner;
 343 };
 344
 345 struct nfs4_openowner {
 346         struct nfs4_stateowner  oo_owner; /* must be first field */
 347         struct list_head        oo_perclient;
 348         /*
 349          * We keep around openowners a little while after last close,
 350          * which saves clients from having to confirm, and allows us to
 351          * handle close replays if they come soon enough.  The close_lru
 352          * is a list of such openowners, to be reaped by the laundromat
 353          * thread eventually if they remain unused:
 354          */
 355         struct list_head        oo_close_lru;
 356         struct nfs4_ol_stateid *oo_last_closed_stid;
 357         time_t                  oo_time; /* time of placement on so_close_lru */
 358 #define NFS4_OO_CONFIRMED   1
 359 #define NFS4_OO_NEW         4
 360         unsigned char           oo_flags;
 361 };
 362
 363 struct nfs4_lockowner {
 364         struct nfs4_stateowner  lo_owner; /* must be first element */
 365 };
 366
 367 static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so)
 368 {
 369         return container_of(so, struct nfs4_openowner, oo_owner);
 370 }
 371
 372 static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so)
 373 {
 374         return container_of(so, struct nfs4_lockowner, lo_owner);
 375 }
 376
 377 /* nfs4_file: a file opened by some number of (open) nfs4_stateowners. */
 378 struct nfs4_file {
 379         atomic_t                fi_ref;
 380         spinlock_t              fi_lock;
 381         struct hlist_node       fi_hash;    /* hash by "struct inode *" */
 382         struct list_head        fi_stateids;
 383         struct list_head        fi_delegations;
 384         /* One each for O_RDONLY, O_WRONLY, O_RDWR: */
 385         struct file *           fi_fds[3];
 386         /*
 387          * Each open or lock stateid contributes 0-4 to the counts
 388          * below depending on which bits are set in st_access_bitmap:
 389          *     1 to fi_access[O_RDONLY] if NFS4_SHARE_ACCES_READ is set
 390          *   + 1 to fi_access[O_WRONLY] if NFS4_SHARE_ACCESS_WRITE is set
 391          *   + 1 to both of the above if NFS4_SHARE_ACCESS_BOTH is set.
 392          */
 393         atomic_t                fi_access[2];
 394         u32                     fi_share_deny;
 395         struct file             *fi_deleg_file;
 396         struct file_lock        *fi_lease;
 397         atomic_t                fi_delegees;
 398         struct inode            *fi_inode;
 399         bool                    fi_had_conflict;
 400 };
 401
 402 /* "ol" stands for "Open or Lock".  Better suggestions welcome. */
 403 struct nfs4_ol_stateid {
 404         struct nfs4_stid    st_stid; /* must be first field */
 405         struct list_head              st_perfile;
 406         struct list_head              st_perstateowner;
 407         struct list_head              st_locks;
 408         struct nfs4_stateowner      * st_stateowner;
 409         struct nfs4_file            * st_file;
 410         unsigned char                 st_access_bmap;
 411         unsigned char                 st_deny_bmap;
 412         struct nfs4_ol_stateid         * st_openstp;
 413 };
 414
 415 static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s)
 416 {
 417         return container_of(s, struct nfs4_ol_stateid, st_stid);
 418 }
 419
 420 /* flags for preprocess_seqid_op() */
 421 #define RD_STATE                0x00000010
 422 #define WR_STATE                0x00000020
 423
 424 struct nfsd4_compound_state;
 425 struct nfsd_net;
 426
 427 extern __be32 nfs4_preprocess_stateid_op(struct net *net,
 428                 struct nfsd4_compound_state *cstate,
 429                 stateid_t *stateid, int flags, struct file **filp);
 430 extern void nfs4_lock_state(void);
 431 extern void nfs4_unlock_state(void);
 432 void nfs4_remove_reclaim_record(struct nfs4_client_reclaim *, struct nfsd_net *);
 433 extern void nfs4_release_reclaim(struct nfsd_net *);
 434 extern struct nfs4_client_reclaim *nfsd4_find_reclaim_client(const char *recdir,
 435                                                         struct nfsd_net *nn);
 436 extern __be32 nfs4_check_open_reclaim(clientid_t *clid,
 437                 struct nfsd4_compound_state *cstate, struct nfsd_net *nn);
 438 extern int set_callback_cred(void);
 439 extern void nfsd4_init_callback(struct nfsd4_callback *);
 440 extern void nfsd4_probe_callback(struct nfs4_client *clp);
 441 extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
 442 extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
 443 extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
 444 extern int nfsd4_create_callback_queue(void);
 445 extern void nfsd4_destroy_callback_queue(void);
 446 extern void nfsd4_shutdown_callback(struct nfs4_client *);
 447 extern void nfs4_put_delegation(struct nfs4_delegation *dp);
 448 extern struct nfs4_client_reclaim *nfs4_client_to_reclaim(const char *name,
 449                                                         struct nfsd_net *nn);
 450 extern bool nfs4_has_reclaimed_state(const char *name, struct nfsd_net *nn);
 451
 452 /* nfs4recover operations */
 453 extern int nfsd4_client_tracking_init(struct net *net);
 454 extern void nfsd4_client_tracking_exit(struct net *net);
 455 extern void nfsd4_client_record_create(struct nfs4_client *clp);
 456 extern void nfsd4_client_record_remove(struct nfs4_client *clp);
 457 extern int nfsd4_client_record_check(struct nfs4_client *clp);
 458 extern void nfsd4_record_grace_done(struct nfsd_net *nn, time_t boot_time);
 459
 460 /* nfs fault injection functions */
 461 #ifdef CONFIG_NFSD_FAULT_INJECTION
 462 int nfsd_fault_inject_init(void);
 463 void nfsd_fault_inject_cleanup(void);
 464 u64 nfsd_for_n_state(u64, u64 (*)(struct nfs4_client *, u64));
 465 struct nfs4_client *nfsd_find_client(struct sockaddr_storage *, size_t);
 466
 467 u64 nfsd_forget_client(struct nfs4_client *, u64);
 468 u64 nfsd_forget_client_locks(struct nfs4_client*, u64);
 469 u64 nfsd_forget_client_openowners(struct nfs4_client *, u64);
 470 u64 nfsd_forget_client_delegations(struct nfs4_client *, u64);
 471 u64 nfsd_recall_client_delegations(struct nfs4_client *, u64);
 472
 473 u64 nfsd_print_client(struct nfs4_client *, u64);
 474 u64 nfsd_print_client_locks(struct nfs4_client *, u64);
 475 u64 nfsd_print_client_openowners(struct nfs4_client *, u64);
 476 u64 nfsd_print_client_delegations(struct nfs4_client *, u64);
 477 #else /* CONFIG_NFSD_FAULT_INJECTION */
 478 static inline int nfsd_fault_inject_init(void) { return 0; }
 479 static inline void nfsd_fault_inject_cleanup(void) {}
 480 #endif /* CONFIG_NFSD_FAULT_INJECTION */
 481
 482 #endif   /* NFSD4_STATE_H */