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         u32                     cb_addr;
  85         unsigned short          cb_port;
  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         struct rpc_cred *       cb_cred;
  93 };
  94
  95 /* Maximum number of slots per session. 128 is useful for long haul TCP */
  96 #define NFSD_MAX_SLOTS_PER_SESSION      128
  97 /* Maximum number of pages per slot cache entry */
  98 #define NFSD_PAGES_PER_SLOT     1
  99 /* Maximum number of operations per session compound */
 100 #define NFSD_MAX_OPS_PER_COMPOUND       16
 101
 102 struct nfsd4_cache_entry {
 103         __be32          ce_status;
 104         struct kvec     ce_datav; /* encoded NFSv4.1 data in rq_res.head[0] */
 105         struct page     *ce_respages[NFSD_PAGES_PER_SLOT + 1];
 106         int             ce_cachethis;
 107         short           ce_resused;
 108         int             ce_opcnt;
 109         int             ce_rpchdrlen;
 110 };
 111
 112 struct nfsd4_slot {
 113         bool                            sl_inuse;
 114         u32                             sl_seqid;
 115         struct nfsd4_cache_entry        sl_cache_entry;
 116 };
 117
 118 struct nfsd4_channel_attrs {
 119         u32             headerpadsz;
 120         u32             maxreq_sz;
 121         u32             maxresp_sz;
 122         u32             maxresp_cached;
 123         u32             maxops;
 124         u32             maxreqs;
 125         u32             nr_rdma_attrs;
 126         u32             rdma_attrs;
 127 };
 128
 129 struct nfsd4_session {
 130         struct kref             se_ref;
 131         struct list_head        se_hash;        /* hash by sessionid */
 132         struct list_head        se_perclnt;
 133         u32                     se_flags;
 134         struct nfs4_client      *se_client;     /* for expire_client */
 135         struct nfs4_sessionid   se_sessionid;
 136         struct nfsd4_channel_attrs se_fchannel;
 137         struct nfsd4_channel_attrs se_bchannel;
 138         struct nfsd4_slot       se_slots[];     /* forward channel slots */
 139 };
 140
 141 static inline void
 142 nfsd4_put_session(struct nfsd4_session *ses)
 143 {
 144         extern void free_session(struct kref *kref);
 145         kref_put(&ses->se_ref, free_session);
 146 }
 147
 148 static inline void
 149 nfsd4_get_session(struct nfsd4_session *ses)
 150 {
 151         kref_get(&ses->se_ref);
 152 }
 153
 154 /* formatted contents of nfs4_sessionid */
 155 struct nfsd4_sessionid {
 156         clientid_t      clientid;
 157         u32             sequence;
 158         u32             reserved;
 159 };
 160
 161 #define HEXDIR_LEN     33 /* hex version of 16 byte md5 of cl_name plus '\0' */
 162
 163 /*
 164  * struct nfs4_client - one per client.  Clientids live here.
 165  *      o Each nfs4_client is hashed by clientid.
 166  *
 167  *      o Each nfs4_clients is also hashed by name
 168  *        (the opaque quantity initially sent by the client to identify itself).
 169  *
 170  *      o cl_perclient list is used to ensure no dangling stateowner references
 171  *        when we expire the nfs4_client
 172  */
 173 struct nfs4_client {
 174         struct list_head        cl_idhash;      /* hash by cl_clientid.id */
 175         struct list_head        cl_strhash;     /* hash by cl_name */
 176         struct list_head        cl_openowners;
 177         struct list_head        cl_delegations;
 178         struct list_head        cl_lru;         /* tail queue */
 179         struct xdr_netobj       cl_name;        /* id generated by client */
 180         char                    cl_recdir[HEXDIR_LEN]; /* recovery dir */
 181         nfs4_verifier           cl_verifier;    /* generated by client */
 182         time_t                  cl_time;        /* time of last lease renewal */
 183         __be32                  cl_addr;        /* client ipaddress */
 184         u32                     cl_flavor;      /* setclientid pseudoflavor */
 185         char                    *cl_principal;  /* setclientid principal name */
 186         struct svc_cred         cl_cred;        /* setclientid principal */
 187         clientid_t              cl_clientid;    /* generated by server */
 188         nfs4_verifier           cl_confirm;     /* generated by server */
 189         struct nfs4_cb_conn     cl_cb_conn;     /* callback info */
 190         atomic_t                cl_count;       /* ref count */
 191         u32                     cl_firststate;  /* recovery dir creation */
 192
 193         /* for nfs41 */
 194         struct list_head        cl_sessions;
 195         struct nfsd4_slot       cl_slot;        /* create_session slot */
 196         u32                     cl_exchange_flags;
 197         struct nfs4_sessionid   cl_sessionid;
 198 };
 199
 200 /* struct nfs4_client_reset
 201  * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
 202  * upon lease reset, or from upcall to state_daemon (to read in state
 203  * from non-volitile storage) upon reboot.
 204  */
 205 struct nfs4_client_reclaim {
 206         struct list_head        cr_strhash;     /* hash by cr_name */
 207         char                    cr_recdir[HEXDIR_LEN]; /* recover dir */
 208 };
 209
 210 static inline void
 211 update_stateid(stateid_t *stateid)
 212 {
 213         stateid->si_generation++;
 214 }
 215
 216 /* A reasonable value for REPLAY_ISIZE was estimated as follows:
 217  * The OPEN response, typically the largest, requires
 218  *   4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) +  8(verifier) +
 219  *   4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
 220  *   20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
 221  */
 222
 223 #define NFSD4_REPLAY_ISIZE       112
 224
 225 /*
 226  * Replay buffer, where the result of the last seqid-mutating operation
 227  * is cached.
 228  */
 229 struct nfs4_replay {
 230         __be32                  rp_status;
 231         unsigned int            rp_buflen;
 232         char                    *rp_buf;
 233         unsigned                intrp_allocated;
 234         struct knfsd_fh         rp_openfh;
 235         char                    rp_ibuf[NFSD4_REPLAY_ISIZE];
 236 };
 237
 238 /*
 239 * nfs4_stateowner can either be an open_owner, or a lock_owner
 240 *
 241 *    so_idhash:  stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
 242 *         for lock_owner
 243 *    so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
 244 *         for lock_owner
 245 *    so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
 246 *         struct is reaped.
 247 *    so_perfilestate: heads the list of nfs4_stateid (either open or lock)
 248 *         and is used to ensure no dangling nfs4_stateid references when we
 249 *         release a stateowner.
 250 *    so_perlockowner: (open) nfs4_stateid->st_perlockowner entry - used when
 251 *         close is called to reap associated byte-range locks
 252 *    so_close_lru: (open) stateowner is placed on this list instead of being
 253 *         reaped (when so_perfilestate is empty) to hold the last close replay.
 254 *         reaped by laundramat thread after lease period.
 255 */
 256 struct nfs4_stateowner {
 257         struct kref             so_ref;
 258         struct list_head        so_idhash;   /* hash by so_id */
 259         struct list_head        so_strhash;   /* hash by op_name */
 260         struct list_head        so_perclient;
 261         struct list_head        so_stateids;
 262         struct list_head        so_perstateid; /* for lockowners only */
 263         struct list_head        so_close_lru; /* tail queue */
 264         time_t                  so_time; /* time of placement on so_close_lru */
 265         int                     so_is_open_owner; /* 1=openowner,0=lockowner */
 266         u32                     so_id;
 267         struct nfs4_client *    so_client;
 268         /* after increment in ENCODE_SEQID_OP_TAIL, represents the next
 269          * sequence id expected from the client: */
 270         u32                     so_seqid;
 271         struct xdr_netobj       so_owner;     /* open owner name */
 272         int                     so_confirmed; /* successful OPEN_CONFIRM? */
 273         struct nfs4_replay      so_replay;
 274 };
 275
 276 /*
 277 *  nfs4_file: a file opened by some number of (open) nfs4_stateowners.
 278 *    o fi_perfile list is used to search for conflicting
 279 *      share_acces, share_deny on the file.
 280 */
 281 struct nfs4_file {
 282         atomic_t                fi_ref;
 283         struct list_head        fi_hash;    /* hash by "struct inode *" */
 284         struct list_head        fi_stateids;
 285         struct list_head        fi_delegations;
 286         struct inode            *fi_inode;
 287         u32                     fi_id;      /* used with stateowner->so_id
 288                                              * for stateid_hashtbl hash */
 289         bool                    fi_had_conflict;
 290 };
 291
 292 /*
 293 * nfs4_stateid can either be an open stateid or (eventually) a lock stateid
 294 *
 295 * (open)nfs4_stateid: one per (open)nfs4_stateowner, nfs4_file
 296 *
 297 *       st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
 298 *       st_perfile: file_hashtbl[] entry.
 299 *       st_perfile_state: nfs4_stateowner->so_perfilestate
 300 *       st_perlockowner: (open stateid) list of lock nfs4_stateowners
 301 *       st_access_bmap: used only for open stateid
 302 *       st_deny_bmap: used only for open stateid
 303 *       st_openstp: open stateid lock stateid was derived from
 304 *
 305 * XXX: open stateids and lock stateids have diverged sufficiently that
 306 * we should consider defining separate structs for the two cases.
 307 */
 308
 309 struct nfs4_stateid {
 310         struct list_head              st_hash;
 311         struct list_head              st_perfile;
 312         struct list_head              st_perstateowner;
 313         struct list_head              st_lockowners;
 314         struct nfs4_stateowner      * st_stateowner;
 315         struct nfs4_file            * st_file;
 316         stateid_t                     st_stateid;
 317         struct file                 * st_vfs_file;
 318         unsigned long                 st_access_bmap;
 319         unsigned long                 st_deny_bmap;
 320         struct nfs4_stateid         * st_openstp;
 321 };
 322
 323 /* flags for preprocess_seqid_op() */
 324 #define HAS_SESSION             0x00000001
 325 #define CONFIRM                 0x00000002
 326 #define OPEN_STATE              0x00000004
 327 #define LOCK_STATE              0x00000008
 328 #define RD_STATE                0x00000010
 329 #define WR_STATE                0x00000020
 330 #define CLOSE_STATE             0x00000040
 331
 332 #define seqid_mutating_err(err)                       \
 333         (((err) != nfserr_stale_clientid) &&    \
 334         ((err) != nfserr_bad_seqid) &&          \
 335         ((err) != nfserr_stale_stateid) &&      \
 336         ((err) != nfserr_bad_stateid))
 337
 338 struct nfsd4_compound_state;
 339
 340 extern __be32 nfs4_preprocess_stateid_op(struct nfsd4_compound_state *cstate,
 341                 stateid_t *stateid, int flags, struct file **filp);
 342 extern void nfs4_lock_state(void);
 343 extern void nfs4_unlock_state(void);
 344 extern int nfs4_in_grace(void);
 345 extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
 346 extern void put_nfs4_client(struct nfs4_client *clp);
 347 extern void nfs4_free_stateowner(struct kref *kref);
 348 extern void nfsd4_probe_callback(struct nfs4_client *clp);
 349 extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
 350 extern void nfs4_put_delegation(struct nfs4_delegation *dp);
 351 extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
 352 extern void nfsd4_init_recdir(char *recdir_name);
 353 extern int nfsd4_recdir_load(void);
 354 extern void nfsd4_shutdown_recdir(void);
 355 extern int nfs4_client_to_reclaim(const char *name);
 356 extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
 357 extern void nfsd4_recdir_purge_old(void);
 358 extern int nfsd4_create_clid_dir(struct nfs4_client *clp);
 359 extern void nfsd4_remove_clid_dir(struct nfs4_client *clp);
 360
 361 static inline void
 362 nfs4_put_stateowner(struct nfs4_stateowner *so)
 363 {
 364         kref_put(&so->so_ref, nfs4_free_stateowner);
 365 }
 366
 367 static inline void
 368 nfs4_get_stateowner(struct nfs4_stateowner *so)
 369 {
 370         kref_get(&so->so_ref);
 371 }
 372
 373 #endif   /* NFSD4_STATE_H */