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