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 <linux/nfsd/nfsfh.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         void *cb_op;
  67         struct nfs4_client *cb_clp;
  68         struct list_head cb_per_client;
  69         u32 cb_minorversion;
  70         struct rpc_message cb_msg;
  71         const struct rpc_call_ops *cb_ops;
  72         struct work_struct cb_work;
  73         bool cb_done;
  74 };
  75
  76 struct nfs4_stid {
  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         unsigned char sc_type;
  85         stateid_t sc_stateid;
  86         struct nfs4_client *sc_client;
  87 };
  88
  89 struct nfs4_delegation {
  90         struct nfs4_stid        dl_stid; /* must be first field */
  91         struct list_head        dl_perfile;
  92         struct list_head        dl_perclnt;
  93         struct list_head        dl_recall_lru;  /* delegation recalled */
  94         atomic_t                dl_count;       /* ref count */
  95         struct nfs4_file        *dl_file;
  96         u32                     dl_type;
  97         time_t                  dl_time;
  98 /* For recall: */
  99         struct knfsd_fh         dl_fh;
 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            1024
 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 extern void nfsd4_put_session(struct nfsd4_session *ses);
 217
 218 /* formatted contents of nfs4_sessionid */
 219 struct nfsd4_sessionid {
 220         clientid_t      clientid;
 221         u32             sequence;
 222         u32             reserved;
 223 };
 224
 225 #define HEXDIR_LEN     33 /* hex version of 16 byte md5 of cl_name plus '\0' */
 226
 227 /*
 228  * struct nfs4_client - one per client.  Clientids live here.
 229  *      o Each nfs4_client is hashed by clientid.
 230  *
 231  *      o Each nfs4_clients is also hashed by name
 232  *        (the opaque quantity initially sent by the client to identify itself).
 233  *
 234  *      o cl_perclient list is used to ensure no dangling stateowner references
 235  *        when we expire the nfs4_client
 236  */
 237 struct nfs4_client {
 238         struct list_head        cl_idhash;      /* hash by cl_clientid.id */
 239         struct rb_node          cl_namenode;    /* link into by-name trees */
 240         struct list_head        cl_openowners;
 241         struct idr              cl_stateids;    /* stateid lookup */
 242         struct list_head        cl_delegations;
 243         struct list_head        cl_revoked;     /* unacknowledged, revoked 4.1 state */
 244         struct list_head        cl_lru;         /* tail queue */
 245         struct xdr_netobj       cl_name;        /* id generated by client */
 246         nfs4_verifier           cl_verifier;    /* generated by client */
 247         time_t                  cl_time;        /* time of last lease renewal */
 248         struct sockaddr_storage cl_addr;        /* client ipaddress */
 249         struct svc_cred         cl_cred;        /* setclientid principal */
 250         clientid_t              cl_clientid;    /* generated by server */
 251         nfs4_verifier           cl_confirm;     /* generated by server */
 252         u32                     cl_minorversion;
 253
 254         /* for v4.0 and v4.1 callbacks: */
 255         struct nfs4_cb_conn     cl_cb_conn;
 256 #define NFSD4_CLIENT_CB_UPDATE          (0)
 257 #define NFSD4_CLIENT_CB_KILL            (1)
 258 #define NFSD4_CLIENT_STABLE             (2)     /* client on stable storage */
 259 #define NFSD4_CLIENT_RECLAIM_COMPLETE   (3)     /* reclaim_complete done */
 260 #define NFSD4_CLIENT_CONFIRMED          (4)     /* client is confirmed */
 261 #define NFSD4_CLIENT_CB_FLAG_MASK       (1 << NFSD4_CLIENT_CB_UPDATE | \
 262                                          1 << NFSD4_CLIENT_CB_KILL)
 263         unsigned long           cl_flags;
 264         struct rpc_cred         *cl_cb_cred;
 265         struct rpc_clnt         *cl_cb_client;
 266         u32                     cl_cb_ident;
 267 #define NFSD4_CB_UP             0
 268 #define NFSD4_CB_UNKNOWN        1
 269 #define NFSD4_CB_DOWN           2
 270 #define NFSD4_CB_FAULT          3
 271         int                     cl_cb_state;
 272         struct nfsd4_callback   cl_cb_null;
 273         struct nfsd4_session    *cl_cb_session;
 274         struct list_head        cl_callbacks; /* list of in-progress callbacks */
 275
 276         /* for all client information that callback code might need: */
 277         spinlock_t              cl_lock;
 278
 279         /* for nfs41 */
 280         struct list_head        cl_sessions;
 281         struct nfsd4_clid_slot  cl_cs_slot;     /* create_session slot */
 282         u32                     cl_exchange_flags;
 283         /* number of rpc's in progress over an associated session: */
 284         atomic_t                cl_refcount;
 285
 286         /* for nfs41 callbacks */
 287         /* We currently support a single back channel with a single slot */
 288         unsigned long           cl_cb_slot_busy;
 289         struct rpc_wait_queue   cl_cb_waitq;    /* backchannel callers may */
 290                                                 /* wait here for slots */
 291         struct net              *net;
 292 };
 293
 294 /* struct nfs4_client_reset
 295  * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
 296  * upon lease reset, or from upcall to state_daemon (to read in state
 297  * from non-volitile storage) upon reboot.
 298  */
 299 struct nfs4_client_reclaim {
 300         struct list_head        cr_strhash;     /* hash by cr_name */
 301         struct nfs4_client      *cr_clp;        /* pointer to associated clp */
 302         char                    cr_recdir[HEXDIR_LEN]; /* recover dir */
 303 };
 304
 305 static inline void
 306 update_stateid(stateid_t *stateid)
 307 {
 308         stateid->si_generation++;
 309         /* Wraparound recommendation from 3530bis-13 9.1.3.2: */
 310         if (stateid->si_generation == 0)
 311                 stateid->si_generation = 1;
 312 }
 313
 314 /* A reasonable value for REPLAY_ISIZE was estimated as follows:
 315  * The OPEN response, typically the largest, requires
 316  *   4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) +  8(verifier) +
 317  *   4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
 318  *   20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
 319  */
 320
 321 #define NFSD4_REPLAY_ISIZE       112
 322
 323 /*
 324  * Replay buffer, where the result of the last seqid-mutating operation
 325  * is cached.
 326  */
 327 struct nfs4_replay {
 328         __be32                  rp_status;
 329         unsigned int            rp_buflen;
 330         char                    *rp_buf;
 331         struct knfsd_fh         rp_openfh;
 332         char                    rp_ibuf[NFSD4_REPLAY_ISIZE];
 333 };
 334
 335 struct nfs4_stateowner {
 336         struct list_head        so_strhash;   /* hash by op_name */
 337         struct list_head        so_stateids;
 338         struct nfs4_client *    so_client;
 339         /* after increment in ENCODE_SEQID_OP_TAIL, represents the next
 340          * sequence id expected from the client: */
 341         u32                     so_seqid;
 342         struct xdr_netobj       so_owner;     /* open owner name */
 343         struct nfs4_replay      so_replay;
 344         bool                    so_is_open_owner;
 345 };
 346
 347 struct nfs4_openowner {
 348         struct nfs4_stateowner  oo_owner; /* must be first field */
 349         struct list_head        oo_perclient;
 350         /*
 351          * We keep around openowners a little while after last close,
 352          * which saves clients from having to confirm, and allows us to
 353          * handle close replays if they come soon enough.  The close_lru
 354          * is a list of such openowners, to be reaped by the laundromat
 355          * thread eventually if they remain unused:
 356          */
 357         struct list_head        oo_close_lru;
 358         struct nfs4_ol_stateid *oo_last_closed_stid;
 359         time_t                  oo_time; /* time of placement on so_close_lru */
 360 #define NFS4_OO_CONFIRMED   1
 361 #define NFS4_OO_NEW         4
 362         unsigned char           oo_flags;
 363 };
 364
 365 struct nfs4_lockowner {
 366         struct nfs4_stateowner  lo_owner; /* must be first element */
 367         struct list_head        lo_owner_ino_hash; /* hash by owner,file */
 368         struct list_head        lo_perstateid;
 369         struct list_head        lo_list; /* for temporary uses */
 370 };
 371
 372 static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so)
 373 {
 374         return container_of(so, struct nfs4_openowner, oo_owner);
 375 }
 376
 377 static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so)
 378 {
 379         return container_of(so, struct nfs4_lockowner, lo_owner);
 380 }
 381
 382 /* nfs4_file: a file opened by some number of (open) nfs4_stateowners. */
 383 struct nfs4_file {
 384         atomic_t                fi_ref;
 385         struct hlist_node       fi_hash;    /* hash by "struct inode *" */
 386         struct list_head        fi_stateids;
 387         struct list_head        fi_delegations;
 388         /* One each for O_RDONLY, O_WRONLY, O_RDWR: */
 389         struct file *           fi_fds[3];
 390         /*
 391          * Each open or lock stateid contributes 0-4 to the counts
 392          * below depending on which bits are set in st_access_bitmap:
 393          *     1 to fi_access[O_RDONLY] if NFS4_SHARE_ACCES_READ is set
 394          *   + 1 to fi_access[O_WRONLY] if NFS4_SHARE_ACCESS_WRITE is set
 395          *   + 1 to both of the above if NFS4_SHARE_ACCESS_BOTH is set.
 396          */
 397         atomic_t                fi_access[2];
 398         struct file             *fi_deleg_file;
 399         struct file_lock        *fi_lease;
 400         atomic_t                fi_delegees;
 401         struct inode            *fi_inode;
 402         bool                    fi_had_conflict;
 403 };
 404
 405 /* XXX: for first cut may fall back on returning file that doesn't work
 406  * at all? */
 407 static inline struct file *find_writeable_file(struct nfs4_file *f)
 408 {
 409         if (f->fi_fds[O_WRONLY])
 410                 return f->fi_fds[O_WRONLY];
 411         return f->fi_fds[O_RDWR];
 412 }
 413
 414 static inline struct file *find_readable_file(struct nfs4_file *f)
 415 {
 416         if (f->fi_fds[O_RDONLY])
 417                 return f->fi_fds[O_RDONLY];
 418         return f->fi_fds[O_RDWR];
 419 }
 420
 421 static inline struct file *find_any_file(struct nfs4_file *f)
 422 {
 423         if (f->fi_fds[O_RDWR])
 424                 return f->fi_fds[O_RDWR];
 425         else if (f->fi_fds[O_WRONLY])
 426                 return f->fi_fds[O_WRONLY];
 427         else
 428                 return f->fi_fds[O_RDONLY];
 429 }
 430
 431 /* "ol" stands for "Open or Lock".  Better suggestions welcome. */
 432 struct nfs4_ol_stateid {
 433         struct nfs4_stid    st_stid; /* must be first field */
 434         struct list_head              st_perfile;
 435         struct list_head              st_perstateowner;
 436         struct list_head              st_lockowners;
 437         struct nfs4_stateowner      * st_stateowner;
 438         struct nfs4_file            * st_file;
 439         unsigned long                 st_access_bmap;
 440         unsigned long                 st_deny_bmap;
 441         struct nfs4_ol_stateid         * st_openstp;
 442 };
 443
 444 static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s)
 445 {
 446         return container_of(s, struct nfs4_ol_stateid, st_stid);
 447 }
 448
 449 /* flags for preprocess_seqid_op() */
 450 #define RD_STATE                0x00000010
 451 #define WR_STATE                0x00000020
 452
 453 struct nfsd4_compound_state;
 454 struct nfsd_net;
 455
 456 extern __be32 nfs4_preprocess_stateid_op(struct net *net,
 457                 struct nfsd4_compound_state *cstate,
 458                 stateid_t *stateid, int flags, struct file **filp);
 459 extern void nfs4_lock_state(void);
 460 extern void nfs4_unlock_state(void);
 461 void nfs4_remove_reclaim_record(struct nfs4_client_reclaim *, struct nfsd_net *);
 462 extern void nfs4_release_reclaim(struct nfsd_net *);
 463 extern struct nfs4_client_reclaim *nfsd4_find_reclaim_client(const char *recdir,
 464                                                         struct nfsd_net *nn);
 465 extern __be32 nfs4_check_open_reclaim(clientid_t *clid, bool sessions, struct nfsd_net *nn);
 466 extern void nfs4_free_openowner(struct nfs4_openowner *);
 467 extern void nfs4_free_lockowner(struct nfs4_lockowner *);
 468 extern int set_callback_cred(void);
 469 extern void nfsd4_init_callback(struct nfsd4_callback *);
 470 extern void nfsd4_probe_callback(struct nfs4_client *clp);
 471 extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
 472 extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
 473 extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
 474 extern int nfsd4_create_callback_queue(void);
 475 extern void nfsd4_destroy_callback_queue(void);
 476 extern void nfsd4_shutdown_callback(struct nfs4_client *);
 477 extern void nfs4_put_delegation(struct nfs4_delegation *dp);
 478 extern struct nfs4_client_reclaim *nfs4_client_to_reclaim(const char *name,
 479                                                         struct nfsd_net *nn);
 480 extern bool nfs4_has_reclaimed_state(const char *name, struct nfsd_net *nn);
 481 extern void put_client_renew(struct nfs4_client *clp);
 482
 483 /* nfs4recover operations */
 484 extern int nfsd4_client_tracking_init(struct net *net);
 485 extern void nfsd4_client_tracking_exit(struct net *net);
 486 extern void nfsd4_client_record_create(struct nfs4_client *clp);
 487 extern void nfsd4_client_record_remove(struct nfs4_client *clp);
 488 extern int nfsd4_client_record_check(struct nfs4_client *clp);
 489 extern void nfsd4_record_grace_done(struct nfsd_net *nn, time_t boot_time);
 490
 491 /* nfs fault injection functions */
 492 #ifdef CONFIG_NFSD_FAULT_INJECTION
 493 int nfsd_fault_inject_init(void);
 494 void nfsd_fault_inject_cleanup(void);
 495 u64 nfsd_for_n_state(u64, u64 (*)(struct nfs4_client *, u64));
 496 struct nfs4_client *nfsd_find_client(struct sockaddr_storage *, size_t);
 497
 498 u64 nfsd_forget_client(struct nfs4_client *, u64);
 499 u64 nfsd_forget_client_locks(struct nfs4_client*, u64);
 500 u64 nfsd_forget_client_openowners(struct nfs4_client *, u64);
 501 u64 nfsd_forget_client_delegations(struct nfs4_client *, u64);
 502 u64 nfsd_recall_client_delegations(struct nfs4_client *, u64);
 503
 504 u64 nfsd_print_client(struct nfs4_client *, u64);
 505 u64 nfsd_print_client_locks(struct nfs4_client *, u64);
 506 u64 nfsd_print_client_openowners(struct nfs4_client *, u64);
 507 u64 nfsd_print_client_delegations(struct nfs4_client *, u64);
 508 #else /* CONFIG_NFSD_FAULT_INJECTION */
 509 static inline int nfsd_fault_inject_init(void) { return 0; }
 510 static inline void nfsd_fault_inject_cleanup(void) {}
 511 #endif /* CONFIG_NFSD_FAULT_INJECTION */
 512
 513 #endif   /* NFSD4_STATE_H */