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         unsigned char sc_type;
  83         stateid_t sc_stateid;
  84         struct nfs4_client *sc_client;
  85 };
  86
  87 struct nfs4_delegation {
  88         struct list_head        dl_perfile;
  89         struct list_head        dl_perclnt;
  90         struct list_head        dl_recall_lru;  /* delegation recalled */
  91         atomic_t                dl_count;       /* ref count */
  92         struct nfs4_file        *dl_file;
  93         u32                     dl_type;
  94         time_t                  dl_time;
  95 /* For recall: */
  96         struct nfs4_stid        dl_stid;
  97         struct knfsd_fh         dl_fh;
  98         int                     dl_retries;
  99         struct nfsd4_callback   dl_recall;
 100 };
 101
 102 /* client delegation callback info */
 103 struct nfs4_cb_conn {
 104         /* SETCLIENTID info */
 105         struct sockaddr_storage cb_addr;
 106         struct sockaddr_storage cb_saddr;
 107         size_t                  cb_addrlen;
 108         u32                     cb_prog; /* used only in 4.0 case;
 109                                             per-session otherwise */
 110         u32                     cb_ident;       /* minorversion 0 only */
 111         struct svc_xprt         *cb_xprt;       /* minorversion 1 only */
 112 };
 113
 114 static inline struct nfs4_delegation *delegstateid(struct nfs4_stid *s)
 115 {
 116         return container_of(s, struct nfs4_delegation, dl_stid);
 117 }
 118
 119 /* Maximum number of slots per session. 160 is useful for long haul TCP */
 120 #define NFSD_MAX_SLOTS_PER_SESSION     160
 121 /* Maximum number of operations per session compound */
 122 #define NFSD_MAX_OPS_PER_COMPOUND       16
 123 /* Maximum  session per slot cache size */
 124 #define NFSD_SLOT_CACHE_SIZE            1024
 125 /* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
 126 #define NFSD_CACHE_SIZE_SLOTS_PER_SESSION       32
 127 #define NFSD_MAX_MEM_PER_SESSION  \
 128                 (NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
 129
 130 struct nfsd4_slot {
 131         bool    sl_inuse;
 132         bool    sl_cachethis;
 133         u16     sl_opcnt;
 134         u32     sl_seqid;
 135         __be32  sl_status;
 136         u32     sl_datalen;
 137         char    sl_data[];
 138 };
 139
 140 struct nfsd4_channel_attrs {
 141         u32             headerpadsz;
 142         u32             maxreq_sz;
 143         u32             maxresp_sz;
 144         u32             maxresp_cached;
 145         u32             maxops;
 146         u32             maxreqs;
 147         u32             nr_rdma_attrs;
 148         u32             rdma_attrs;
 149 };
 150
 151 struct nfsd4_create_session {
 152         clientid_t                      clientid;
 153         struct nfs4_sessionid           sessionid;
 154         u32                             seqid;
 155         u32                             flags;
 156         struct nfsd4_channel_attrs      fore_channel;
 157         struct nfsd4_channel_attrs      back_channel;
 158         u32                             callback_prog;
 159         u32                             uid;
 160         u32                             gid;
 161 };
 162
 163 struct nfsd4_bind_conn_to_session {
 164         struct nfs4_sessionid           sessionid;
 165         u32                             dir;
 166 };
 167
 168 /* The single slot clientid cache structure */
 169 struct nfsd4_clid_slot {
 170         u32                             sl_seqid;
 171         __be32                          sl_status;
 172         struct nfsd4_create_session     sl_cr_ses;
 173 };
 174
 175 struct nfsd4_conn {
 176         struct list_head cn_persession;
 177         struct svc_xprt *cn_xprt;
 178         struct svc_xpt_user cn_xpt_user;
 179         struct nfsd4_session *cn_session;
 180 /* CDFC4_FORE, CDFC4_BACK: */
 181         unsigned char cn_flags;
 182 };
 183
 184 struct nfsd4_session {
 185         struct kref             se_ref;
 186         struct list_head        se_hash;        /* hash by sessionid */
 187         struct list_head        se_perclnt;
 188         u32                     se_flags;
 189         struct nfs4_client      *se_client;
 190         struct nfs4_sessionid   se_sessionid;
 191         struct nfsd4_channel_attrs se_fchannel;
 192         struct nfsd4_channel_attrs se_bchannel;
 193         struct list_head        se_conns;
 194         u32                     se_cb_prog;
 195         u32                     se_cb_seq_nr;
 196         struct nfsd4_slot       *se_slots[];    /* forward channel slots */
 197 };
 198
 199 static inline void
 200 nfsd4_put_session(struct nfsd4_session *ses)
 201 {
 202         extern void free_session(struct kref *kref);
 203         kref_put(&ses->se_ref, free_session);
 204 }
 205
 206 static inline void
 207 nfsd4_get_session(struct nfsd4_session *ses)
 208 {
 209         kref_get(&ses->se_ref);
 210 }
 211
 212 /* formatted contents of nfs4_sessionid */
 213 struct nfsd4_sessionid {
 214         clientid_t      clientid;
 215         u32             sequence;
 216         u32             reserved;
 217 };
 218
 219 #define HEXDIR_LEN     33 /* hex version of 16 byte md5 of cl_name plus '\0' */
 220
 221 /*
 222  * struct nfs4_client - one per client.  Clientids live here.
 223  *      o Each nfs4_client is hashed by clientid.
 224  *
 225  *      o Each nfs4_clients is also hashed by name
 226  *        (the opaque quantity initially sent by the client to identify itself).
 227  *
 228  *      o cl_perclient list is used to ensure no dangling stateowner references
 229  *        when we expire the nfs4_client
 230  */
 231 struct nfs4_client {
 232         struct list_head        cl_idhash;      /* hash by cl_clientid.id */
 233         struct list_head        cl_strhash;     /* hash by cl_name */
 234         struct list_head        cl_openowners;
 235         struct idr              cl_stateids;    /* stateid lookup */
 236         struct list_head        cl_delegations;
 237         struct list_head        cl_lru;         /* tail queue */
 238         struct xdr_netobj       cl_name;        /* id generated by client */
 239         char                    cl_recdir[HEXDIR_LEN]; /* recovery dir */
 240         nfs4_verifier           cl_verifier;    /* generated by client */
 241         time_t                  cl_time;        /* time of last lease renewal */
 242         struct sockaddr_storage cl_addr;        /* client ipaddress */
 243         u32                     cl_flavor;      /* setclientid pseudoflavor */
 244         char                    *cl_principal;  /* setclientid principal name */
 245         struct svc_cred         cl_cred;        /* setclientid principal */
 246         clientid_t              cl_clientid;    /* generated by server */
 247         nfs4_verifier           cl_confirm;     /* generated by server */
 248         u32                     cl_firststate;  /* recovery dir creation */
 249         u32                     cl_minorversion;
 250
 251         /* for v4.0 and v4.1 callbacks: */
 252         struct nfs4_cb_conn     cl_cb_conn;
 253 #define NFSD4_CLIENT_CB_UPDATE  1
 254 #define NFSD4_CLIENT_KILL       2
 255         unsigned long           cl_cb_flags;
 256         struct rpc_clnt         *cl_cb_client;
 257         u32                     cl_cb_ident;
 258 #define NFSD4_CB_UP             0
 259 #define NFSD4_CB_UNKNOWN        1
 260 #define NFSD4_CB_DOWN           2
 261         int                     cl_cb_state;
 262         struct nfsd4_callback   cl_cb_null;
 263         struct nfsd4_session    *cl_cb_session;
 264         struct list_head        cl_callbacks; /* list of in-progress callbacks */
 265
 266         /* for all client information that callback code might need: */
 267         spinlock_t              cl_lock;
 268
 269         /* for nfs41 */
 270         struct list_head        cl_sessions;
 271         struct nfsd4_clid_slot  cl_cs_slot;     /* create_session slot */
 272         u32                     cl_exchange_flags;
 273         /* number of rpc's in progress over an associated session: */
 274         atomic_t                cl_refcount;
 275
 276         /* for nfs41 callbacks */
 277         /* We currently support a single back channel with a single slot */
 278         unsigned long           cl_cb_slot_busy;
 279         struct rpc_wait_queue   cl_cb_waitq;    /* backchannel callers may */
 280                                                 /* wait here for slots */
 281 };
 282
 283 static inline void
 284 mark_client_expired(struct nfs4_client *clp)
 285 {
 286         clp->cl_time = 0;
 287 }
 288
 289 static inline bool
 290 is_client_expired(struct nfs4_client *clp)
 291 {
 292         return clp->cl_time == 0;
 293 }
 294
 295 /* struct nfs4_client_reset
 296  * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
 297  * upon lease reset, or from upcall to state_daemon (to read in state
 298  * from non-volitile storage) upon reboot.
 299  */
 300 struct nfs4_client_reclaim {
 301         struct list_head        cr_strhash;     /* hash by cr_name */
 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         int                     so_is_open_owner; /* 1=openowner,0=lockowner */
 339         struct nfs4_client *    so_client;
 340         /* after increment in ENCODE_SEQID_OP_TAIL, represents the next
 341          * sequence id expected from the client: */
 342         u32                     so_seqid;
 343         struct xdr_netobj       so_owner;     /* open owner name */
 344         struct nfs4_replay      so_replay;
 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_PURGE_CLOSE 2
 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_perstateid; /* for lockowners only */
 368         struct list_head        lo_list; /* for temporary uses */
 369 };
 370
 371 static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so)
 372 {
 373         return container_of(so, struct nfs4_openowner, oo_owner);
 374 }
 375
 376 static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so)
 377 {
 378         return container_of(so, struct nfs4_lockowner, lo_owner);
 379 }
 380
 381 /*
 382 *  nfs4_file: a file opened by some number of (open) nfs4_stateowners.
 383 *    o fi_perfile list is used to search for conflicting
 384 *      share_acces, share_deny on the file.
 385 */
 386 struct nfs4_file {
 387         atomic_t                fi_ref;
 388         struct list_head        fi_hash;    /* hash by "struct inode *" */
 389         struct list_head        fi_stateids;
 390         struct list_head        fi_delegations;
 391         /* One each for O_RDONLY, O_WRONLY, O_RDWR: */
 392         struct file *           fi_fds[3];
 393         /*
 394          * Each open or lock stateid contributes 0-4 to the counts
 395          * below depending on which bits are set in st_access_bitmap:
 396          *     1 to fi_access[O_RDONLY] if NFS4_SHARE_ACCES_READ is set
 397          *   + 1 to fi_access[O_WRONLY] if NFS4_SHARE_ACCESS_WRITE is set
 398          *   + 1 to both of the above if NFS4_SHARE_ACCESS_BOTH is set.
 399          */
 400         atomic_t                fi_access[2];
 401         struct file             *fi_deleg_file;
 402         struct file_lock        *fi_lease;
 403         atomic_t                fi_delegees;
 404         struct inode            *fi_inode;
 405         bool                    fi_had_conflict;
 406 };
 407
 408 /* XXX: for first cut may fall back on returning file that doesn't work
 409  * at all? */
 410 static inline struct file *find_writeable_file(struct nfs4_file *f)
 411 {
 412         if (f->fi_fds[O_WRONLY])
 413                 return f->fi_fds[O_WRONLY];
 414         return f->fi_fds[O_RDWR];
 415 }
 416
 417 static inline struct file *find_readable_file(struct nfs4_file *f)
 418 {
 419         if (f->fi_fds[O_RDONLY])
 420                 return f->fi_fds[O_RDONLY];
 421         return f->fi_fds[O_RDWR];
 422 }
 423
 424 static inline struct file *find_any_file(struct nfs4_file *f)
 425 {
 426         if (f->fi_fds[O_RDWR])
 427                 return f->fi_fds[O_RDWR];
 428         else if (f->fi_fds[O_WRONLY])
 429                 return f->fi_fds[O_WRONLY];
 430         else
 431                 return f->fi_fds[O_RDONLY];
 432 }
 433
 434 /* "ol" stands for "Open or Lock".  Better suggestions welcome. */
 435 struct nfs4_ol_stateid {
 436         struct nfs4_stid    st_stid;
 437         struct list_head              st_perfile;
 438         struct list_head              st_perstateowner;
 439         struct list_head              st_lockowners;
 440         struct nfs4_stateowner      * st_stateowner;
 441         struct nfs4_file            * st_file;
 442         unsigned long                 st_access_bmap;
 443         unsigned long                 st_deny_bmap;
 444         struct nfs4_ol_stateid         * st_openstp;
 445 };
 446
 447 static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s)
 448 {
 449         return container_of(s, struct nfs4_ol_stateid, st_stid);
 450 }
 451
 452 /* flags for preprocess_seqid_op() */
 453 #define RD_STATE                0x00000010
 454 #define WR_STATE                0x00000020
 455
 456 struct nfsd4_compound_state;
 457
 458 extern __be32 nfs4_preprocess_stateid_op(struct nfsd4_compound_state *cstate,
 459                 stateid_t *stateid, int flags, struct file **filp);
 460 extern void nfs4_lock_state(void);
 461 extern void nfs4_unlock_state(void);
 462 extern int nfs4_in_grace(void);
 463 extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
 464 extern void nfs4_free_openowner(struct nfs4_openowner *);
 465 extern void nfs4_free_lockowner(struct nfs4_lockowner *);
 466 extern int set_callback_cred(void);
 467 extern void nfsd4_probe_callback(struct nfs4_client *clp);
 468 extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
 469 extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *);
 470 extern void nfsd4_do_callback_rpc(struct work_struct *);
 471 extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
 472 extern int nfsd4_create_callback_queue(void);
 473 extern void nfsd4_destroy_callback_queue(void);
 474 extern void nfsd4_shutdown_callback(struct nfs4_client *);
 475 extern void nfs4_put_delegation(struct nfs4_delegation *dp);
 476 extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
 477 extern void nfsd4_init_recdir(void);
 478 extern int nfsd4_recdir_load(void);
 479 extern void nfsd4_shutdown_recdir(void);
 480 extern int nfs4_client_to_reclaim(const char *name);
 481 extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
 482 extern void nfsd4_recdir_purge_old(void);
 483 extern int nfsd4_create_clid_dir(struct nfs4_client *clp);
 484 extern void nfsd4_remove_clid_dir(struct nfs4_client *clp);
 485 extern void release_session_client(struct nfsd4_session *);
 486 extern __be32 nfs4_validate_stateid(struct nfs4_client *, stateid_t *);
 487 extern void nfsd4_purge_closed_stateid(struct nfs4_stateowner *);
 488
 489 #endif   /* NFSD4_STATE_H */