include/linux/nfsd/state.h

   1 /*
   2  *  linux/include/nfsd/state.h
   3  *
   4  *  Copyright (c) 2001 The Regents of the University of Michigan.
   5  *  All rights reserved.
   6  *
   7  *  Kendrick Smith <kmsmith@umich.edu>
   8  *  Andy Adamson <andros@umich.edu>
   9  *
  10  *  Redistribution and use in source and binary forms, with or without
  11  *  modification, are permitted provided that the following conditions
  12  *  are met:
  13  *
  14  *  1. Redistributions of source code must retain the above copyright
  15  *     notice, this list of conditions and the following disclaimer.
  16  *  2. Redistributions in binary form must reproduce the above copyright
  17  *     notice, this list of conditions and the following disclaimer in the
  18  *     documentation and/or other materials provided with the distribution.
  19  *  3. Neither the name of the University nor the names of its
  20  *     contributors may be used to endorse or promote products derived
  21  *     from this software without specific prior written permission.
  22  *
  23  *  THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
  24  *  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  25  *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  26  *  DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  27  *  FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  28  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  29  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  30  *  BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  31  *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  32  *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  33  *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34  *
  35  */
  36
  37 #ifndef _NFSD4_STATE_H
  38 #define _NFSD4_STATE_H
  39
  40 #include <linux/list.h>
  41 #include <linux/kref.h>
  42 #include <linux/sunrpc/clnt.h>
  43
  44 typedef struct {
  45         u32             cl_boot;
  46         u32             cl_id;
  47 } clientid_t;
  48
  49 typedef struct {
  50         u32             so_boot;
  51         u32             so_stateownerid;
  52         u32             so_fileid;
  53 } stateid_opaque_t;
  54
  55 typedef struct {
  56         u32                     si_generation;
  57         stateid_opaque_t        si_opaque;
  58 } stateid_t;
  59 #define si_boot           si_opaque.so_boot
  60 #define si_stateownerid   si_opaque.so_stateownerid
  61 #define si_fileid         si_opaque.so_fileid
  62
  63 struct nfs4_delegation {
  64         struct list_head        dl_perfile;
  65         struct list_head        dl_perclnt;
  66         struct list_head        dl_recall_lru;  /* delegation recalled */
  67         atomic_t                dl_count;       /* ref count */
  68         struct nfs4_client      *dl_client;
  69         struct nfs4_file        *dl_file;
  70         struct file_lock        *dl_flock;
  71         struct file             *dl_vfs_file;
  72         u32                     dl_type;
  73         time_t                  dl_time;
  74 /* For recall: */
  75         u32                     dl_ident;
  76         stateid_t               dl_stateid;
  77         struct knfsd_fh         dl_fh;
  78         int                     dl_retries;
  79 };
  80
  81 /* client delegation callback info */
  82 struct nfs4_cb_conn {
  83         /* SETCLIENTID info */
  84         struct sockaddr_storage cb_addr;
  85         size_t                  cb_addrlen;
  86         u32                     cb_prog;
  87         u32                     cb_minorversion;
  88         u32                     cb_ident;       /* minorversion 0 only */
  89         /* RPC client info */
  90         atomic_t                cb_set;     /* successful CB_NULL call */
  91         struct rpc_clnt *       cb_client;
  92 };
  93
  94 /* Maximum number of slots per session. 160 is useful for long haul TCP */
  95 #define NFSD_MAX_SLOTS_PER_SESSION     160
  96 /* Maximum number of operations per session compound */
  97 #define NFSD_MAX_OPS_PER_COMPOUND       16
  98 /* Maximum  session per slot cache size */
  99 #define NFSD_SLOT_CACHE_SIZE            1024
 100 /* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
 101 #define NFSD_CACHE_SIZE_SLOTS_PER_SESSION       32
 102 #define NFSD_MAX_MEM_PER_SESSION  \
 103                 (NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
 104
 105 struct nfsd4_slot {
 106         bool    sl_inuse;
 107         bool    sl_cachethis;
 108         u16     sl_opcnt;
 109         u32     sl_seqid;
 110         __be32  sl_status;
 111         u32     sl_datalen;
 112         char    sl_data[];
 113 };
 114
 115 struct nfsd4_channel_attrs {
 116         u32             headerpadsz;
 117         u32             maxreq_sz;
 118         u32             maxresp_sz;
 119         u32             maxresp_cached;
 120         u32             maxops;
 121         u32             maxreqs;
 122         u32             nr_rdma_attrs;
 123         u32             rdma_attrs;
 124 };
 125
 126 struct nfsd4_create_session {
 127         clientid_t                      clientid;
 128         struct nfs4_sessionid           sessionid;
 129         u32                             seqid;
 130         u32                             flags;
 131         struct nfsd4_channel_attrs      fore_channel;
 132         struct nfsd4_channel_attrs      back_channel;
 133         u32                             callback_prog;
 134         u32                             uid;
 135         u32                             gid;
 136 };
 137
 138 /* The single slot clientid cache structure */
 139 struct nfsd4_clid_slot {
 140         u32                             sl_seqid;
 141         __be32                          sl_status;
 142         struct nfsd4_create_session     sl_cr_ses;
 143 };
 144
 145 struct nfsd4_session {
 146         struct kref             se_ref;
 147         struct list_head        se_hash;        /* hash by sessionid */
 148         struct list_head        se_perclnt;
 149         u32                     se_flags;
 150         struct nfs4_client      *se_client;     /* for expire_client */
 151         struct nfs4_sessionid   se_sessionid;
 152         struct nfsd4_channel_attrs se_fchannel;
 153         struct nfsd4_channel_attrs se_bchannel;
 154         struct nfsd4_slot       *se_slots[];    /* forward channel slots */
 155 };
 156
 157 static inline void
 158 nfsd4_put_session(struct nfsd4_session *ses)
 159 {
 160         extern void free_session(struct kref *kref);
 161         kref_put(&ses->se_ref, free_session);
 162 }
 163
 164 static inline void
 165 nfsd4_get_session(struct nfsd4_session *ses)
 166 {
 167         kref_get(&ses->se_ref);
 168 }
 169
 170 /* formatted contents of nfs4_sessionid */
 171 struct nfsd4_sessionid {
 172         clientid_t      clientid;
 173         u32             sequence;
 174         u32             reserved;
 175 };
 176
 177 #define HEXDIR_LEN     33 /* hex version of 16 byte md5 of cl_name plus '\0' */
 178
 179 /*
 180  * struct nfs4_client - one per client.  Clientids live here.
 181  *      o Each nfs4_client is hashed by clientid.
 182  *
 183  *      o Each nfs4_clients is also hashed by name
 184  *        (the opaque quantity initially sent by the client to identify itself).
 185  *
 186  *      o cl_perclient list is used to ensure no dangling stateowner references
 187  *        when we expire the nfs4_client
 188  */
 189 struct nfs4_client {
 190         struct list_head        cl_idhash;      /* hash by cl_clientid.id */
 191         struct list_head        cl_strhash;     /* hash by cl_name */
 192         struct list_head        cl_openowners;
 193         struct list_head        cl_delegations;
 194         struct list_head        cl_lru;         /* tail queue */
 195         struct xdr_netobj       cl_name;        /* id generated by client */
 196         char                    cl_recdir[HEXDIR_LEN]; /* recovery dir */
 197         nfs4_verifier           cl_verifier;    /* generated by client */
 198         time_t                  cl_time;        /* time of last lease renewal */
 199         struct sockaddr_storage cl_addr;        /* client ipaddress */
 200         u32                     cl_flavor;      /* setclientid pseudoflavor */
 201         char                    *cl_principal;  /* setclientid principal name */
 202         struct svc_cred         cl_cred;        /* setclientid principal */
 203         clientid_t              cl_clientid;    /* generated by server */
 204         nfs4_verifier           cl_confirm;     /* generated by server */
 205         struct nfs4_cb_conn     cl_cb_conn;     /* callback info */
 206         atomic_t                cl_count;       /* ref count */
 207         u32                     cl_firststate;  /* recovery dir creation */
 208
 209         /* for nfs41 */
 210         struct list_head        cl_sessions;
 211         struct nfsd4_clid_slot  cl_cs_slot;     /* create_session slot */
 212         u32                     cl_exchange_flags;
 213         struct nfs4_sessionid   cl_sessionid;
 214
 215         /* for nfs41 callbacks */
 216         struct svc_xprt         *cl_cb_xprt;    /* 4.1 callback transport */
 217 };
 218
 219 /* struct nfs4_client_reset
 220  * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
 221  * upon lease reset, or from upcall to state_daemon (to read in state
 222  * from non-volitile storage) upon reboot.
 223  */
 224 struct nfs4_client_reclaim {
 225         struct list_head        cr_strhash;     /* hash by cr_name */
 226         char                    cr_recdir[HEXDIR_LEN]; /* recover dir */
 227 };
 228
 229 static inline void
 230 update_stateid(stateid_t *stateid)
 231 {
 232         stateid->si_generation++;
 233 }
 234
 235 /* A reasonable value for REPLAY_ISIZE was estimated as follows:
 236  * The OPEN response, typically the largest, requires
 237  *   4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) +  8(verifier) +
 238  *   4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
 239  *   20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
 240  */
 241
 242 #define NFSD4_REPLAY_ISIZE       112
 243
 244 /*
 245  * Replay buffer, where the result of the last seqid-mutating operation
 246  * is cached.
 247  */
 248 struct nfs4_replay {
 249         __be32                  rp_status;
 250         unsigned int            rp_buflen;
 251         char                    *rp_buf;
 252         unsigned                intrp_allocated;
 253         struct knfsd_fh         rp_openfh;
 254         char                    rp_ibuf[NFSD4_REPLAY_ISIZE];
 255 };
 256
 257 /*
 258 * nfs4_stateowner can either be an open_owner, or a lock_owner
 259 *
 260 *    so_idhash:  stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
 261 *         for lock_owner
 262 *    so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
 263 *         for lock_owner
 264 *    so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
 265 *         struct is reaped.
 266 *    so_perfilestate: heads the list of nfs4_stateid (either open or lock)
 267 *         and is used to ensure no dangling nfs4_stateid references when we
 268 *         release a stateowner.
 269 *    so_perlockowner: (open) nfs4_stateid->st_perlockowner entry - used when
 270 *         close is called to reap associated byte-range locks
 271 *    so_close_lru: (open) stateowner is placed on this list instead of being
 272 *         reaped (when so_perfilestate is empty) to hold the last close replay.
 273 *         reaped by laundramat thread after lease period.
 274 */
 275 struct nfs4_stateowner {
 276         struct kref             so_ref;
 277         struct list_head        so_idhash;   /* hash by so_id */
 278         struct list_head        so_strhash;   /* hash by op_name */
 279         struct list_head        so_perclient;
 280         struct list_head        so_stateids;
 281         struct list_head        so_perstateid; /* for lockowners only */
 282         struct list_head        so_close_lru; /* tail queue */
 283         time_t                  so_time; /* time of placement on so_close_lru */
 284         int                     so_is_open_owner; /* 1=openowner,0=lockowner */
 285         u32                     so_id;
 286         struct nfs4_client *    so_client;
 287         /* after increment in ENCODE_SEQID_OP_TAIL, represents the next
 288          * sequence id expected from the client: */
 289         u32                     so_seqid;
 290         struct xdr_netobj       so_owner;     /* open owner name */
 291         int                     so_confirmed; /* successful OPEN_CONFIRM? */
 292         struct nfs4_replay      so_replay;
 293 };
 294
 295 /*
 296 *  nfs4_file: a file opened by some number of (open) nfs4_stateowners.
 297 *    o fi_perfile list is used to search for conflicting
 298 *      share_acces, share_deny on the file.
 299 */
 300 struct nfs4_file {
 301         atomic_t                fi_ref;
 302         struct list_head        fi_hash;    /* hash by "struct inode *" */
 303         struct list_head        fi_stateids;
 304         struct list_head        fi_delegations;
 305         struct inode            *fi_inode;
 306         u32                     fi_id;      /* used with stateowner->so_id
 307                                              * for stateid_hashtbl hash */
 308         bool                    fi_had_conflict;
 309 };
 310
 311 /*
 312 * nfs4_stateid can either be an open stateid or (eventually) a lock stateid
 313 *
 314 * (open)nfs4_stateid: one per (open)nfs4_stateowner, nfs4_file
 315 *
 316 *       st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
 317 *       st_perfile: file_hashtbl[] entry.
 318 *       st_perfile_state: nfs4_stateowner->so_perfilestate
 319 *       st_perlockowner: (open stateid) list of lock nfs4_stateowners
 320 *       st_access_bmap: used only for open stateid
 321 *       st_deny_bmap: used only for open stateid
 322 *       st_openstp: open stateid lock stateid was derived from
 323 *
 324 * XXX: open stateids and lock stateids have diverged sufficiently that
 325 * we should consider defining separate structs for the two cases.
 326 */
 327
 328 struct nfs4_stateid {
 329         struct list_head              st_hash;
 330         struct list_head              st_perfile;
 331         struct list_head              st_perstateowner;
 332         struct list_head              st_lockowners;
 333         struct nfs4_stateowner      * st_stateowner;
 334         struct nfs4_file            * st_file;
 335         stateid_t                     st_stateid;
 336         struct file                 * st_vfs_file;
 337         unsigned long                 st_access_bmap;
 338         unsigned long                 st_deny_bmap;
 339         struct nfs4_stateid         * st_openstp;
 340 };
 341
 342 /* flags for preprocess_seqid_op() */
 343 #define HAS_SESSION             0x00000001
 344 #define CONFIRM                 0x00000002
 345 #define OPEN_STATE              0x00000004
 346 #define LOCK_STATE              0x00000008
 347 #define RD_STATE                0x00000010
 348 #define WR_STATE                0x00000020
 349 #define CLOSE_STATE             0x00000040
 350
 351 #define seqid_mutating_err(err)                       \
 352         (((err) != nfserr_stale_clientid) &&    \
 353         ((err) != nfserr_bad_seqid) &&          \
 354         ((err) != nfserr_stale_stateid) &&      \
 355         ((err) != nfserr_bad_stateid))
 356
 357 struct nfsd4_compound_state;
 358
 359 extern __be32 nfs4_preprocess_stateid_op(struct nfsd4_compound_state *cstate,
 360                 stateid_t *stateid, int flags, struct file **filp);
 361 extern void nfs4_lock_state(void);
 362 extern void nfs4_unlock_state(void);
 363 extern int nfs4_in_grace(void);
 364 extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
 365 extern void put_nfs4_client(struct nfs4_client *clp);
 366 extern void nfs4_free_stateowner(struct kref *kref);
 367 extern int set_callback_cred(void);
 368 extern void nfsd4_probe_callback(struct nfs4_client *clp);
 369 extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
 370 extern void nfs4_put_delegation(struct nfs4_delegation *dp);
 371 extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
 372 extern void nfsd4_init_recdir(char *recdir_name);
 373 extern int nfsd4_recdir_load(void);
 374 extern void nfsd4_shutdown_recdir(void);
 375 extern int nfs4_client_to_reclaim(const char *name);
 376 extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
 377 extern void nfsd4_recdir_purge_old(void);
 378 extern int nfsd4_create_clid_dir(struct nfs4_client *clp);
 379 extern void nfsd4_remove_clid_dir(struct nfs4_client *clp);
 380
 381 static inline void
 382 nfs4_put_stateowner(struct nfs4_stateowner *so)
 383 {
 384         kref_put(&so->so_ref, nfs4_free_stateowner);
 385 }
 386
 387 static inline void
 388 nfs4_get_stateowner(struct nfs4_stateowner *so)
 389 {
 390         kref_get(&so->so_ref);
 391 }
 392
 393 #endif   /* NFSD4_STATE_H */